From 6c100fad5e2f7a1e4982b756c198c99838fa7cab Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 12 Aug 2026 14:47:06 +0000 Subject: [PATCH 1/3] chore(deps): Bump sphinx-substitution-extensions Bumps [sphinx-substitution-extensions](https://github.com/adamtheturtle/sphinx-substitution-extensions) from 2026.6.17 to 2026.8.5. - [Release notes](https://github.com/adamtheturtle/sphinx-substitution-extensions/releases) - [Changelog](https://github.com/adamtheturtle/sphinx-substitution-extensions/blob/main/CHANGELOG.rst) - [Commits](https://github.com/adamtheturtle/sphinx-substitution-extensions/compare/2026.06.17...2026.08.05) --- updated-dependencies: - dependency-name: sphinx-substitution-extensions dependency-version: 2026.8.5 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- pyproject.toml | 2 +- uv.lock | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 76f8e1e5d..12696bca6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -92,7 +92,7 @@ optional-dependencies.dev = [ "sphinx-lint==1.0.2", "sphinx-paramlinks==0.6", "sphinx-pyproject==0.3.0", - "sphinx-substitution-extensions==2026.6.17", + "sphinx-substitution-extensions==2026.8.5", "sphinx-toolbox==4.3.0", "sphinxcontrib-httpdomain==2.0.0", "sphinxcontrib-spelling==8.0.2", diff --git a/uv.lock b/uv.lock index f7a43fadf..f1cb70257 100644 --- a/uv.lock +++ b/uv.lock @@ -2218,7 +2218,7 @@ wheels = [ [[package]] name = "sphinx-substitution-extensions" -version = "2026.6.17" +version = "2026.8.5" source = { registry = "https://pypi.org/simple" } dependencies = [ { name = "beartype" }, @@ -2226,9 +2226,9 @@ dependencies = [ { name = "myst-parser" }, { name = "sphinx" }, ] -sdist = { url = "https://files.pythonhosted.org/packages/dd/fb/6bf1b3e5bbd97d6f4632e2bb8f48518f8400cf0e4d2949f15be5a933b068/sphinx_substitution_extensions-2026.6.17.tar.gz", hash = "sha256:b7901937a43853bdaa97408ab8d73c9dc3497ec9bcf3a0c4b5fb2cce8baece13", size = 37045, upload-time = "2026-06-17T09:57:31.943Z" } +sdist = { url = "https://files.pythonhosted.org/packages/07/d9/d7bd4d3a396b05fa441b46e70d6b50971b219a521ffef5cc1f17f2aff7ed/sphinx_substitution_extensions-2026.8.5.tar.gz", hash = "sha256:c64c0c3cd4d2d4c59d761252876b0fd8367e1023bc54e333bf06b1a434965503", size = 42300, upload-time = "2026-08-05T12:21:17.361Z" } wheels = [ - { url = "https://files.pythonhosted.org/packages/38/e9/b8f35529c3fa1fd3efd232113c5342bef4ab0cb703a1a3beda2fcccb6392/sphinx_substitution_extensions-2026.6.17-py2.py3-none-any.whl", hash = "sha256:9971b1e402d13faaca903af894130a831218f78e8e266d36cbcddad83b7f7609", size = 10152, upload-time = "2026-06-17T09:57:30.783Z" }, + { url = "https://files.pythonhosted.org/packages/66/2a/8d3315e55c53c56db1a178e78a6081d65fde7607f6ae8f9b81e91cf5e8d9/sphinx_substitution_extensions-2026.8.5-py3-none-any.whl", hash = "sha256:2eda9c056ccf760cf227c0f76cfc6e7875c89fa8edacf64e7518fcfbd029c623", size = 11773, upload-time = "2026-08-05T12:21:16.21Z" }, ] [[package]] @@ -2843,7 +2843,7 @@ requires-dist = [ { name = "sphinx-lint", marker = "extra == 'dev'", specifier = "==1.0.2" }, { name = "sphinx-paramlinks", marker = "extra == 'dev'", specifier = "==0.6" }, { name = "sphinx-pyproject", marker = "extra == 'dev'", specifier = "==0.3.0" }, - { name = "sphinx-substitution-extensions", marker = "extra == 'dev'", specifier = "==2026.6.17" }, + { name = "sphinx-substitution-extensions", marker = "extra == 'dev'", specifier = "==2026.8.5" }, { name = "sphinx-toolbox", marker = "extra == 'dev'", specifier = "==4.3.0" }, { name = "sphinxcontrib-httpdomain", marker = "extra == 'dev'", specifier = "==2.0.0" }, { name = "sphinxcontrib-spelling", marker = "extra == 'dev'", specifier = "==8.0.2" }, From 3493dd47e6110b489f04f7fa80d3e3147ddc2c5d Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Wed, 12 Aug 2026 18:16:42 +0100 Subject: [PATCH 2/3] Exclude include-only doc fragments from the Sphinx document collection sphinx-substitution-extensions 2026.8.5 overrides the ``include`` directive with a subclass of the docutils ``Include`` directive, which does not register included files with ``env.note_included``. Sphinx therefore warns that ``basic-example.rst`` and ``httpx-example.rst`` are not in any toctree, and ``-W`` turns that into an error. Exclude the fragments from the document collection instead; ``include`` reads the raw files so they still render into ``index.rst``. Co-Authored-By: Claude Fable 5 --- docs/source/conf.py | 5 +++++ pyproject.toml | 1 + 2 files changed, 6 insertions(+) diff --git a/docs/source/conf.py b/docs/source/conf.py index 7ffa7efca..b83c0dd2e 100755 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -42,6 +42,11 @@ autodoc_use_legacy_class_based = True templates_path = ["_templates"] + +# These fragments are pulled into ``index.rst`` with ``include`` directives +# rather than a toctree, so keep them out of the document collection to avoid +# ``toc.not_included`` warnings. +exclude_patterns = ["basic-example.rst", "httpx-example.rst"] source_suffix = ".rst" master_doc = "index" diff --git a/pyproject.toml b/pyproject.toml index 12696bca6..d0de2242f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -371,6 +371,7 @@ ignore_names = [ "DatabaseDict", # Too difficult to test (see notes in the code) "DATE_RANGE_ERROR", + "exclude_patterns", "extensions", # pytest fixtures - we name fixtures like this for this purpose "fixture_*", From 169bbd0b3b6448454b9c0a09d2fb78b549820e8c Mon Sep 17 00:00:00 2001 From: Adam Dangoor Date: Wed, 12 Aug 2026 18:35:11 +0100 Subject: [PATCH 3/3] Add toctree to the pylint spelling dictionary Co-Authored-By: Claude Fable 5 --- spelling_private_dict.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/spelling_private_dict.txt b/spelling_private_dict.txt index ef4380bc2..7bdfc5998 100644 --- a/spelling_private_dict.txt +++ b/spelling_private_dict.txt @@ -113,6 +113,7 @@ str stringify subprocess timestamp +toctree todo travis txt