From 846d23ce3d576648987382b6f1adcd7584ca7dee Mon Sep 17 00:00:00 2001 From: sneakers-the-rat Date: Wed, 7 May 2025 18:24:12 -0700 Subject: [PATCH 1/2] pass env to language session --- conf.py | 2 +- noxfile.py | 10 ++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/conf.py b/conf.py index 49c3ec4e..63f08d5b 100644 --- a/conf.py +++ b/conf.py @@ -95,7 +95,7 @@ {"href": "https://www.pyopensci.org/images/favicon.ico"}, ] -html_baseurl = "https://www.pyopensci.org/python-package-guide/" +html_baseurl = "/python-package-guide/" if not sphinx_env == "production": # for links in language selector when developing locally html_baseurl = "/" diff --git a/noxfile.py b/noxfile.py index fe70c482..174995bc 100644 --- a/noxfile.py +++ b/noxfile.py @@ -78,7 +78,7 @@ def docs_test(session): env={'SPHINX_ENV': 'production'}) # When building the guide with additional parameters, also build the translations in RELEASE_LANGUAGES # with those same parameters. - session.notify("build-release-languages", [*TEST_PARAMETERS, *session.posargs]) + session.notify("build-release-languages", ["production", *TEST_PARAMETERS, *session.posargs]) def _autobuild_cmd(posargs: list[str], output_dir = OUTPUT_DIR) -> list[str]: cmd = [SPHINX_AUTO_BUILD, *BUILD_PARAMETERS, str(SOURCE_DIR), str(output_dir), *posargs] @@ -274,7 +274,6 @@ def build_release_languages(session): session.install("-e", ".") for lang in RELEASE_LANGUAGES: session.log(f"Building [{lang}] guide") - session.run(SPHINX_BUILD, *BUILD_PARAMETERS, "-D", f"language={lang}", ".", OUTPUT_DIR / lang, *session.posargs) if lang == 'en': out_dir = OUTPUT_DIR else: @@ -328,6 +327,9 @@ def _sphinx_env(session) -> str: ``SPHINX_ENV`` environment variable, defaulting to "development" """ if session.posargs and session.posargs[0] in SPHINX_ENVS: - return session.posargs.pop(0) + env = session.posargs.pop(0) + session.log(f"Using SPHINX_ENV={env} from posargs") else: - return os.environ.get('SPHINX_ENV', 'development') + env = os.environ.get('SPHINX_ENV', 'development') + session.log(f"Using SPHINX_ENV={env} from os.environ") + return env From f1d662d9e046f5fb9b227cb9d185bbb2dfc919d0 Mon Sep 17 00:00:00 2001 From: sneakers-the-rat Date: Wed, 7 May 2025 18:37:49 -0700 Subject: [PATCH 2/2] separate lang selector baseurl from sphinx config baseurl --- conf.py | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/conf.py b/conf.py index 63f08d5b..f7099152 100644 --- a/conf.py +++ b/conf.py @@ -95,10 +95,11 @@ {"href": "https://www.pyopensci.org/images/favicon.ico"}, ] -html_baseurl = "/python-package-guide/" +html_baseurl = "https://www.pyopensci.org/python-package-guide/" +lang_selector_baseurl = "/python-package-guide/" if not sphinx_env == "production": # for links in language selector when developing locally - html_baseurl = "/" + lang_selector_baseurl = "/" html_theme_options = { "announcement": "

We run peer review of scientific Python software. Learn more.

", @@ -148,7 +149,7 @@ "github_version": "main", "language": language, "languages": build_languages, - "baseurl": html_baseurl, + "baseurl": lang_selector_baseurl, } # Add any paths that contain templates here, relative to this directory.