From 10df8765b47550d3404f1aaa6ff50071ac870a4e Mon Sep 17 00:00:00 2001 From: Romain Geissler Date: Sun, 26 Jan 2025 22:20:26 +0000 Subject: [PATCH 1/3] Fix doc build with Sphinx 8. See this Fedora failure following the upgrade to Sphinx 8: https://bugzilla.redhat.com/show_bug.cgi?id=2329853 --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 17f81b1..9c533da 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -291,4 +291,4 @@ # Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} +intersphinx_mapping = {'python': ('https://docs.python.org/3', None)} From 253a50038134b874116e9d2b68608f412ddc2d3c Mon Sep 17 00:00:00 2001 From: Tom Most Date: Fri, 24 Apr 2026 18:53:05 -0700 Subject: [PATCH 2/3] Add Sphinx build to CI --- .github/workflows/ci.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index f7dbaf6..834b36d 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -143,12 +143,16 @@ jobs: python-version: ${{ env.DEFAULT_PYTHON_VERSION }} - name: Install dependencies run: | - python -m pip install --upgrade pydoctor + python -m pip install --upgrade pydoctor sphinx - name: Run pydoctor run: | pydoctor --project-name constantly constantly + - name: Run Sphinx + run: | + sphinx-build -W -b html docs/ docs/_build/html + # Used for various release automation. # This is also executed for each PR to exercise the release as much From 4f80eeceb06c8de102f832b774bf6f130c7dbf49 Mon Sep 17 00:00:00 2001 From: Tom Most Date: Fri, 24 Apr 2026 18:56:12 -0700 Subject: [PATCH 3/3] Sphinx: Add language config Addressing this warning: WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English). --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 9c533da..989e5d2 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -70,7 +70,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: