From b0b44ea5245dba88f644b2a44372cf850293200e Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Thu, 23 Apr 2026 04:09:51 -0700 Subject: [PATCH 1/3] Correct errors in Sphinx build by using SHA for version and ignore SECURITY --- conf.py | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/conf.py b/conf.py index 076bafca..16171b71 100644 --- a/conf.py +++ b/conf.py @@ -54,18 +54,21 @@ else: build_languages = ["en"] + languages -# Get the latest Git tag - there might be a prettier way to do this but... +# Use only the Git SHA for the Sphinx "release" string. +# (Sphinx doesn't require PEP 440 here, but we keep it well-formed and stable.) try: release_value = ( - subprocess.check_output(["git", "describe", "--tags"]) + subprocess.check_output(["git", "rev-parse", "--short=12", "HEAD"]) .decode("utf-8") .strip() ) - release_value = release_value[:4] -except subprocess.CalledProcessError: - release_value = "0.1" # Default value in case there's no tag + # Basic check: short SHA should be hex. + if not release_value or any(c not in "0123456789abcdef" for c in release_value.lower()): + raise ValueError(f"Unexpected git sha: {release_value!r}") +except (subprocess.CalledProcessError, FileNotFoundError, ValueError): + # Fallback when building from a source archive or without git available + release_value = "unknown" -# Update the release value release = release_value # -- General configuration --------------------------------------------------- @@ -181,7 +184,8 @@ ".venv", "venv", "env", - "LICENSE.rst" + "LICENSE.rst", + "SECURITY.md" ] # For sitemap generation From 75f20e8e00f272d27fe13a73e0cc0b23bc162c8d Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Thu, 23 Apr 2026 04:22:03 -0700 Subject: [PATCH 2/3] Apply review suggestion from agriyakhetarpal --- conf.py | 3 --- 1 file changed, 3 deletions(-) diff --git a/conf.py b/conf.py index 16171b71..beedf3ee 100644 --- a/conf.py +++ b/conf.py @@ -62,9 +62,6 @@ .decode("utf-8") .strip() ) - # Basic check: short SHA should be hex. - if not release_value or any(c not in "0123456789abcdef" for c in release_value.lower()): - raise ValueError(f"Unexpected git sha: {release_value!r}") except (subprocess.CalledProcessError, FileNotFoundError, ValueError): # Fallback when building from a source archive or without git available release_value = "unknown" From 4d4539e916d1e7211fbf48e95740b8ae73a07f8f Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Thu, 23 Apr 2026 04:31:37 -0700 Subject: [PATCH 3/3] Change fetch_depth to fetch-depth for action --- .github/workflows/build-book.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build-book.yml b/.github/workflows/build-book.yml index 026aa556..48c9a7a6 100644 --- a/.github/workflows/build-book.yml +++ b/.github/workflows/build-book.yml @@ -23,7 +23,7 @@ jobs: steps: - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 with: - fetch_depth: 0 + fetch-depth: 0 - name: Restore mtimes from git history run: |