From df662a36e1f513158e1b158754ca415abe8797f6 Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Fri, 17 Apr 2026 13:06:12 -0700 Subject: [PATCH 01/12] feat: add default support for sphinx-llm --- docs/Makefile | 4 ++-- docs/conf.py | 1 + .../optional-customisation/bridge-project-and-docs-builds.rst | 2 +- docs/reference/default-extensions.rst | 3 +++ docs/requirements.txt | 1 + 5 files changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 74151955..582438f8 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -10,7 +10,7 @@ SPHINX_OPTS ?= -c . -d $(SPHINX_DIR)/.doctrees -j auto SPHINX_BUILD ?= $(DOCS_VENVDIR)/bin/sphinx-build SPHINX_HOST ?= 127.0.0.1 SPHINX_PORT ?= 8000 -SPHINX_AUTOBUILD_OPTS ?= +SPHINX_AUTOBUILD_OPTS ?= -D=llms_txt_enabled=0 DOCS_VENVDIR ?= .venv DOCS_VENV ?= $(DOCS_VENVDIR)/bin/activate DOCS_SOURCEDIR ?= . @@ -79,7 +79,7 @@ pymarkdownlnt-install: install install: $(DOCS_VENVDIR) run: install - . $(DOCS_VENV); $(DOCS_VENVDIR)/bin/sphinx-autobuild -b dirhtml --host $(SPHINX_HOST) --port $(SPHINX_PORT) "$(DOCS_SOURCEDIR)" "$(DOCS_BUILDDIR)" $(SPHINX_OPTS) $(SPHINX_AUTOBUILD_OPTS) + . $(DOCS_VENV); $(DOCS_VENVDIR)/bin/sphinx-autobuild -b dirhtml --host $(SPHINX_HOST) --port $(SPHINX_PORT) "$(DOCS_SOURCEDIR)" "$(DOCS_BUILDDIR)" $(SPHINX_OPTS) $(SPHINX_AUTOBUILD_OPTS) # Does not depend on $(DOCS_BUILDDIR) to rebuild properly at every run. html: install diff --git a/docs/conf.py b/docs/conf.py index b0aad1f5..eb467cee 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -287,6 +287,7 @@ "sphinx_config_options", "sphinx_contributor_listing", "sphinx_filtered_toctree", + "sphinx_llm.txt", "sphinx_related_links", "sphinx_roles", "sphinx_terminal", diff --git a/docs/how-to/optional-customisation/bridge-project-and-docs-builds.rst b/docs/how-to/optional-customisation/bridge-project-and-docs-builds.rst index 9228c4dc..521f7ca8 100644 --- a/docs/how-to/optional-customisation/bridge-project-and-docs-builds.rst +++ b/docs/how-to/optional-customisation/bridge-project-and-docs-builds.rst @@ -270,7 +270,7 @@ In the example project, the main build calls the targets like this: For example, within the main build, if you need to customize ``SPHINX_AUTOBUILD_OPTS``, pass it to the docs build like this: - .. code-block:: make + .. code-block:: :caption: Makefile $(MAKE) -C docs run SPHINX_AUTOBUILD_OPTS="$(SPHINX_AUTOBUILD_OPTS)" diff --git a/docs/reference/default-extensions.rst b/docs/reference/default-extensions.rst index dfb1e5c1..164c9020 100644 --- a/docs/reference/default-extensions.rst +++ b/docs/reference/default-extensions.rst @@ -62,6 +62,9 @@ These extensions are enabled in the Starter Pack by default. ``sphinx_last_updated_by_git`` Fetches and displays the accurate 'last updated' date for pages by reading Git commit metadata. +``sphinx_llm.txt`` + Generates Markdown artifacts that improve readability for LLMs. + ``sphinx_related_links`` Generates and injects a list of related links into documentation pages. diff --git a/docs/requirements.txt b/docs/requirements.txt index 6016a35a..e5779119 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -27,6 +27,7 @@ packaging sphinxcontrib-svg2pdfconverter[CairoSVG] sphinx-last-updated-by-git sphinx-sitemap +sphinx-llm # Vale dependencies rst2html From 54314a07721fa01f94ae11c364bce0c143bf846b Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Fri, 17 Apr 2026 13:27:06 -0700 Subject: [PATCH 02/12] docs: clean up changelog --- CHANGELOG.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1ccbcfac..cf589244 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,22 +2,30 @@ ## Upcoming -* Separate default configuration for copyright and license statements. +* Add an `AUTOBUILD_EXTRA_OPTS` variable to extend sphinx-autobuild options for `make run`. +* Add default support for the sphinx-llm extension. + +### Changed + +* `docs/conf.py` [#590](https://github.com/canonical/sphinx-docs-starter-pack/pull/590) +* `docs/Makefile` [#575](https://github.com/canonical/sphinx-docs-starter-pack/pull/575), [#590](https://github.com/canonical/sphinx-docs-starter-pack/pull/590) +* `docs/requirements.txt` [#590]([#590](https://github.com/canonical/sphinx-docs-starter-pack/pull/590)) + +## 1.6 + * Fix the handling of non-zero exit codes from pymarkdownlnt. * Add a how-to guide about testing the Ulwazi theme. * Move the Python virtual environment from `docs/.sphinx/venv` to `docs/.venv`. * Make rediraffe the default extension for page redirects * Add default templates for the Canonical cookie banner and Google Analytics. -* Add an `AUTOBUILD_EXTRA_OPTS` variable to extend sphinx-autobuild options for `make run`. ### Changed -* `docs/conf.py` [#562](https://github.com/canonical/sphinx-docs-starter-pack/pull/562) * `.github/workflows/check-removed-urls.yml` [#552](https://github.com/canonical/sphinx-docs-starter-pack/pull/552) * `.github/workflows/sphinx-python-dependency-build-checks.yml` [#552](https://github.com/canonical/sphinx-docs-starter-pack/pull/552) * `docs/.gitignore` [#552](https://github.com/canonical/sphinx-docs-starter-pack/pull/552) * `docs/.sphinx/.wordlist.txt` [#520](https://github.com/canonical/sphinx-docs-starter-pack/pull/520) -* `docs/conf.py` [#549](https://github.com/canonical/sphinx-docs-starter-pack/pull/549), [#558](https://github.com/canonical/sphinx-docs-starter-pack/pull/558), [#552](https://github.com/canonical/sphinx-docs-starter-pack/pull/552), [#558](https://github.com/canonical/sphinx-docs-starter-pack/pull/558) +* `docs/conf.py` [#549](https://github.com/canonical/sphinx-docs-starter-pack/pull/549), [#558](https://github.com/canonical/sphinx-docs-starter-pack/pull/558), [#552](https://github.com/canonical/sphinx-docs-starter-pack/pull/552), [#558](https://github.com/canonical/sphinx-docs-starter-pack/pull/558), [#562](https://github.com/canonical/sphinx-docs-starter-pack/pull/562) * `docs/Makefile` [#551](https://github.com/canonical/sphinx-docs-starter-pack/pull/551), [#552](https://github.com/canonical/sphinx-docs-starter-pack/pull/552) * `docs/redirects.txt` [#558](https://github.com/canonical/sphinx-docs-starter-pack/pull/558) * `docs/_templates/header.html` [#549](https://github.com/canonical/sphinx-docs-starter-pack/pull/549) From 4fb004c84ad9ddecf4d9a63dfa42edbfc6af0691 Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Fri, 17 Apr 2026 13:38:38 -0700 Subject: [PATCH 03/12] docs: fix spelling errors --- docs/.custom_wordlist.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/.custom_wordlist.txt b/docs/.custom_wordlist.txt index f64ae67e..08c6b940 100644 --- a/docs/.custom_wordlist.txt +++ b/docs/.custom_wordlist.txt @@ -20,12 +20,14 @@ Kompare lang LaTeX latexmk +LLMs? Multipass otf plantuml PNG Pygments pymarkdown +pymarkdownlnt QEMU Rockcraft readthedocs @@ -74,7 +76,7 @@ sequenceDiagram Numpy openapi docstrings? -Makefile +Makefiles? rediraffe retrigger(ing)? Diátaxis From 4b5f0e7b507384dbd9fa408f71bc503d11ce7d37 Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Fri, 24 Apr 2026 12:04:21 -0700 Subject: [PATCH 04/12] docs: add meta descriptions --- docs/how-to/contributing-myst.md | 3 +++ docs/how-to/contributing.rst | 2 +- docs/reference/myst-syntax.md | 2 ++ docs/reference/rst-syntax.rst | 3 +++ 4 files changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/how-to/contributing-myst.md b/docs/how-to/contributing-myst.md index f8707224..6ddaf586 100644 --- a/docs/how-to/contributing-myst.md +++ b/docs/how-to/contributing-myst.md @@ -1,4 +1,7 @@ --- +myst: + html_meta: + description: Contribute to the documentation project with code, writing, or testing. orphan: true --- diff --git a/docs/how-to/contributing.rst b/docs/how-to/contributing.rst index cc50b4e3..0aca6f15 100644 --- a/docs/how-to/contributing.rst +++ b/docs/how-to/contributing.rst @@ -1,5 +1,5 @@ .. meta:: - :description: How to contribute to the documentation project with code, writing, or testing. + :description: Contribute to the documentation project with code, writing, or testing. :orphan: diff --git a/docs/reference/myst-syntax.md b/docs/reference/myst-syntax.md index 93920910..9d386158 100644 --- a/docs/reference/myst-syntax.md +++ b/docs/reference/myst-syntax.md @@ -1,6 +1,8 @@ --- relatedlinks: https://github.com/canonical/canonical-sphinx-extensions, [reStructuredText Primer](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html), [Canonical Documentation Style Guide](https://docs.ubuntu.com/styleguide/en) myst: + html_meta: + description: Find examples of the MyST syntax used in Canonical documentation files. substitutions: advanced_reuse_key: "This is a substitution that includes a code block: ``` diff --git a/docs/reference/rst-syntax.rst b/docs/reference/rst-syntax.rst index 88558f38..7695f998 100644 --- a/docs/reference/rst-syntax.rst +++ b/docs/reference/rst-syntax.rst @@ -1,3 +1,6 @@ +.. meta:: + :description: Find examples of the reStructuredText syntax used in Canonical documentation files. + :relatedlinks: https://github.com/canonical/lxd-sphinx-extensions, [reStructuredText Primer](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html), [Canonical Documentation Style Guide](https://docs.ubuntu.com/styleguide/en) .. _rst-syntax: From 93ca1a19385264807a36e43cdc7c2b11b2366005 Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Fri, 24 Apr 2026 12:09:40 -0700 Subject: [PATCH 05/12] docs: add remaining descriptions --- docs/how-to/run-documentation-checks.rst | 3 +++ docs/reference/github-workflows.rst | 3 +++ 2 files changed, 6 insertions(+) diff --git a/docs/how-to/run-documentation-checks.rst b/docs/how-to/run-documentation-checks.rst index 7515e46a..ddd67ee0 100644 --- a/docs/how-to/run-documentation-checks.rst +++ b/docs/how-to/run-documentation-checks.rst @@ -1,3 +1,6 @@ +.. meta:: + :description: Verify your documentation's spelling, links, and language with built-in checks. + .. _run-documentation-checks : Run documentation checks diff --git a/docs/reference/github-workflows.rst b/docs/reference/github-workflows.rst index e3c1a928..44dcb31f 100644 --- a/docs/reference/github-workflows.rst +++ b/docs/reference/github-workflows.rst @@ -1,3 +1,6 @@ +.. meta:: + :description: The Starter Pack ships with GitHub workflows to check your documentation's spelling, links, and language in CI. + .. _github-workflows: GitHub workflows From 45a354ab018b39aed779ce35f0e3e204e207f88a Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Fri, 24 Apr 2026 12:12:51 -0700 Subject: [PATCH 06/12] chore(revert): syntax highlighting --- .../optional-customisation/bridge-project-and-docs-builds.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to/optional-customisation/bridge-project-and-docs-builds.rst b/docs/how-to/optional-customisation/bridge-project-and-docs-builds.rst index 3fd203cb..469c3ea3 100644 --- a/docs/how-to/optional-customisation/bridge-project-and-docs-builds.rst +++ b/docs/how-to/optional-customisation/bridge-project-and-docs-builds.rst @@ -272,7 +272,7 @@ In the example project, the main build calls the targets like this: For example, within the main build, if you need to customize ``SPHINX_AUTOBUILD_OPTS``, pass it to the docs build like this: - .. code-block:: + .. code-block:: make :caption: Makefile $(MAKE) -C docs run SPHINX_AUTOBUILD_OPTS="$(SPHINX_AUTOBUILD_OPTS)" From 1168136f506b05f2b1db5317c82bde2a1e7b059c Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Mon, 27 Apr 2026 09:32:11 -0700 Subject: [PATCH 07/12] feat: add default sphinx-llm config --- docs/conf.py | 51 +++++++++++++++++++++++++++++++++------------------ 1 file changed, 33 insertions(+), 18 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index eb467cee..e467e043 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,6 @@ import datetime import os + import yaml # Configuration for the Sphinx documentation builder. @@ -29,7 +30,7 @@ # The year in the copyright statement defaults to the current year, so # individual document versions show when they were built. -# TODO: If the date must be a range, like in a software license, replace +# TODO: If the date must be a range, like in a software license, replace # 2026 with the starting year of development and use: # # copyright = f"2026-{datetime.date.today().year}" @@ -118,11 +119,9 @@ # Docs branch in the repo; used in links for viewing the source files # # TODO: To customise the branch, uncomment and update as needed. - 'repo_default_branch': 'main', + "repo_default_branch": "main", # Docs location in the repo; used in links for viewing the source files # - - # TODO: To customise the directory, uncomment and update as needed. "repo_folder": "/docs/", # TODO: To enable or disable the Previous / Next buttons at the bottom of pages @@ -130,13 +129,10 @@ # "sequential_nav": "both", # TODO: To enable listing contributors on individual pages, set to True "display_contributors": False, - - # Required for feedback button - 'github_issues': 'enabled', - + # Required for feedback button + "github_issues": "enabled", # Inherit the author value "author": author, - # The starter pack uses CC-BY-SA as the license # # TODO: If your docs need another license, specify it instead of 'CC-BY-SA'. @@ -148,7 +144,6 @@ # # TODO: If your documentation is a part of the code repository of your project, # it inherits the code license instead; specify it instead of 'CC-BY-SA'. - "license": { "name": "CC-BY-SA-3.0", "url": "https://github.com/canonical/sphinx-docs-starter-pack/blob/main/LICENSE", @@ -190,7 +185,7 @@ # sphinx-sitemap uses html_baseurl to generate the full URL for each page: -sitemap_url_scheme = '{link}' +sitemap_url_scheme = "{link}" # Include `lastmod` dates in the sitemap: @@ -199,9 +194,9 @@ # Exclude generated pages from the sitemap: sitemap_excludes = [ - '404/', - 'genindex/', - 'search/', + "404/", + "genindex/", + "search/", ] # TODO: Add more pages to sitemap_excludes if needed. Wildcards are supported. @@ -231,6 +226,23 @@ rediraffe_dir_only = True +############################ +# sphinx-llm configuration # +############################ + +# This description is included in llms.txt to provide some initial context for your +# product docs. +# TODO: Write one or two sentences that describe your documentation. +llms_txt_description = """\ + This documentation describes Canonical's Sphinx Starter Pack, a template repository + for Sphinx documentation projects. The Starter Pack provides a standard set of + configuration files, Sphinx extensions, and Make targets to help users write, + maintain, and publish documentation for their products. + """ + +# The base URL for references built by sphinx-markdown-builder. +markdown_http_base = html_baseurl + ########################### # Link checker exceptions # ########################### @@ -246,7 +258,7 @@ "https://example.com", # SourceForge domains often block linkcheck r"https://.*\.sourceforge\.(net|io)/.*", - ] +] # A regex list of URLs where anchors are ignored by 'make linkcheck' @@ -369,12 +381,15 @@ # Workaround for substitutions.yaml -if os.path.exists('./reuse/substitutions.yaml'): - with open('./reuse/substitutions.yaml', 'r') as fd: +if os.path.exists("./reuse/substitutions.yaml"): + with open("./reuse/substitutions.yaml", "r") as fd: myst_substitutions = yaml.safe_load(fd.read()) # Add configuration for intersphinx mapping # Map only the Sphinx documentation sets that you need to link to from your docs set. intersphinx_mapping = { - 'sphinxcontrib-mermaid': ('https://sphinxcontrib-mermaid-demo.readthedocs.io/en/latest', None) + "sphinxcontrib-mermaid": ( + "https://sphinxcontrib-mermaid-demo.readthedocs.io/en/latest", + None, + ) } From e0b44caedd4fb27989b84b3864c79f3734382186 Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Mon, 27 Apr 2026 12:26:52 -0700 Subject: [PATCH 08/12] fix: dedent llms_txt_description --- docs/conf.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index e467e043..c2398656 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,5 +1,6 @@ import datetime import os +import textwrap import yaml @@ -233,12 +234,14 @@ # This description is included in llms.txt to provide some initial context for your # product docs. # TODO: Write one or two sentences that describe your documentation. -llms_txt_description = """\ +llms_txt_description = textwrap.dedent( + """\ This documentation describes Canonical's Sphinx Starter Pack, a template repository for Sphinx documentation projects. The Starter Pack provides a standard set of configuration files, Sphinx extensions, and Make targets to help users write, maintain, and publish documentation for their products. """ +) # The base URL for references built by sphinx-markdown-builder. markdown_http_base = html_baseurl From 4a6771469c67cc37266d7325f552202a8f7d470f Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Mon, 27 Apr 2026 12:37:25 -0700 Subject: [PATCH 09/12] fix: markdown_http_base --- docs/conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index c2398656..953eba53 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -244,7 +244,8 @@ ) # The base URL for references built by sphinx-markdown-builder. -markdown_http_base = html_baseurl +if os.environ.get("READTHEDOCS"): + markdown_http_base = html_baseurl ########################### # Link checker exceptions # From 47f855515d8142df3c7341d701d0d9e8c544aecc Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Mon, 27 Apr 2026 12:42:56 -0700 Subject: [PATCH 10/12] docs: tweak meta descriptions --- docs/how-to/contributing-myst.md | 2 +- docs/how-to/contributing.rst | 2 +- docs/how-to/run-documentation-checks.rst | 2 +- docs/reference/github-workflows.rst | 2 +- docs/reference/myst-syntax.md | 2 +- docs/reference/rst-syntax.rst | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/how-to/contributing-myst.md b/docs/how-to/contributing-myst.md index 6ddaf586..2efcd9c6 100644 --- a/docs/how-to/contributing-myst.md +++ b/docs/how-to/contributing-myst.md @@ -1,7 +1,7 @@ --- myst: html_meta: - description: Contribute to the documentation project with code, writing, or testing. + description: How to contribute code, documentation, and tests to the Starter Pack. orphan: true --- diff --git a/docs/how-to/contributing.rst b/docs/how-to/contributing.rst index 0aca6f15..82f97354 100644 --- a/docs/how-to/contributing.rst +++ b/docs/how-to/contributing.rst @@ -1,5 +1,5 @@ .. meta:: - :description: Contribute to the documentation project with code, writing, or testing. + :description: How to contribute code, documentation, and tests to the Starter Pack. :orphan: diff --git a/docs/how-to/run-documentation-checks.rst b/docs/how-to/run-documentation-checks.rst index ddd67ee0..6b9a2a9b 100644 --- a/docs/how-to/run-documentation-checks.rst +++ b/docs/how-to/run-documentation-checks.rst @@ -1,5 +1,5 @@ .. meta:: - :description: Verify your documentation's spelling, links, and language with built-in checks. + :description: How to verify your documentation's spelling, links, and language with built-in checks. .. _run-documentation-checks : diff --git a/docs/reference/github-workflows.rst b/docs/reference/github-workflows.rst index 44dcb31f..bcd3b9d9 100644 --- a/docs/reference/github-workflows.rst +++ b/docs/reference/github-workflows.rst @@ -1,5 +1,5 @@ .. meta:: - :description: The Starter Pack ships with GitHub workflows to check your documentation's spelling, links, and language in CI. + :description: Reference for the built-in GitHub workflows that check your documentation's spelling, links, and language. .. _github-workflows: diff --git a/docs/reference/myst-syntax.md b/docs/reference/myst-syntax.md index 9d386158..5ba0fbf4 100644 --- a/docs/reference/myst-syntax.md +++ b/docs/reference/myst-syntax.md @@ -2,7 +2,7 @@ relatedlinks: https://github.com/canonical/canonical-sphinx-extensions, [reStructuredText Primer](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html), [Canonical Documentation Style Guide](https://docs.ubuntu.com/styleguide/en) myst: html_meta: - description: Find examples of the MyST syntax used in Canonical documentation files. + description: Reference for the MyST syntax conventions used by Canonical. substitutions: advanced_reuse_key: "This is a substitution that includes a code block: ``` diff --git a/docs/reference/rst-syntax.rst b/docs/reference/rst-syntax.rst index 7695f998..a0f40206 100644 --- a/docs/reference/rst-syntax.rst +++ b/docs/reference/rst-syntax.rst @@ -1,5 +1,5 @@ .. meta:: - :description: Find examples of the reStructuredText syntax used in Canonical documentation files. + :description: Reference for the reStructuredText syntax conventions used by Canonical. :relatedlinks: https://github.com/canonical/lxd-sphinx-extensions, [reStructuredText Primer](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html), [Canonical Documentation Style Guide](https://docs.ubuntu.com/styleguide/en) From ecaa448cbfad5c9d6c4398c64b60aae28224ea14 Mon Sep 17 00:00:00 2001 From: jahn-junior Date: Tue, 28 Apr 2026 15:49:37 -0700 Subject: [PATCH 11/12] build(docs): tweak llms_txt_description --- docs/conf.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 953eba53..e13f2ec7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -233,13 +233,12 @@ # This description is included in llms.txt to provide some initial context for your # product docs. -# TODO: Write one or two sentences that describe your documentation. +# TODO: Add a description in the form "This is the documentation for , +# ". llms_txt_description = textwrap.dedent( """\ - This documentation describes Canonical's Sphinx Starter Pack, a template repository - for Sphinx documentation projects. The Starter Pack provides a standard set of - configuration files, Sphinx extensions, and Make targets to help users write, - maintain, and publish documentation for their products. + This is the documentation for the Sphinx Starter Pack, a template repository + that helps you set up, build, and publish Sphinx documentation. """ ) From 8a3849bc8310ba830091b7a68318e91cdf0fd5ed Mon Sep 17 00:00:00 2001 From: JJ Coldiron Date: Thu, 30 Apr 2026 13:44:19 -0700 Subject: [PATCH 12/12] build(deps): pin sphinx-llm to major version --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index e5779119..69bb2995 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -27,7 +27,7 @@ packaging sphinxcontrib-svg2pdfconverter[CairoSVG] sphinx-last-updated-by-git sphinx-sitemap -sphinx-llm +sphinx-llm~=0.4 # Vale dependencies rst2html