docs: Update to the latest version of the Sphinx Stack#794
Merged
Conversation
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
skoech
force-pushed
the
update-sphinx-stack
branch
from
July 6, 2026 13:19
336e77b to
ce13a5e
Compare
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
lmlg
approved these changes
Jul 6, 2026
lmlg
left a comment
Contributor
There was a problem hiding this comment.
lgtm, the tests failures have been explained and are expected.
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
Collaborator
Author
|
Thanks, @lmlg. Attempting to fix the check-removed-url check failure. |
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
skoech
force-pushed
the
update-sphinx-stack
branch
from
July 6, 2026 16:03
4766351 to
545a0a1
Compare
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
2 tasks
roosterfish
added a commit
to canonical/microcloud
that referenced
this pull request
Jul 7, 2026
- Updates MicroOVN docs URL following the move to ubuntu.com/docs/microovn. - Updates the MicroCeph build directory variable after `BUILDDIR` was changed to `DOCS_BUILDDIR` in canonical/microceph#794. ## Checklist - [x] I have read the [contributing guidelines](https://github.com/canonical/microcloud/blob/main/CONTRIBUTING.md) and attest that all commits in this PR are [signed off](https://github.com/canonical/microcloud/blob/main/CONTRIBUTING.md#including-a-signed-off-by-line-in-your-commits), [cryptographically signed](https://github.com/canonical/microcloud/blob/main/CONTRIBUTING.md#commit-signature-verification), and follow this project's [commit structure](https://github.com/canonical/microcloud/blob/main/CONTRIBUTING.md#commit-structure). - [x] I have checked and added or updated relevant documentation.
7 tasks
lmlg
pushed a commit
that referenced
this pull request
Jul 7, 2026
# Description This PR adds license info to the footer of the docs. Sphinx Stack v2.0 aligns the copyright statement in the footer with legal standards, but this change was neglected in #794. Release notes prescription: ``` To incorporate this change in your documentation, add the license information to html_context in your conf.py file: html_context = { "license": { "name": "CC-BY-SA-3.0", "url": "https://github.com/canonical/sphinx-docs-starter-pack/blob/main/LICENSE", }, } ``` ## Type of change - Documentation update (change to documentation only) ## How has this been tested? Tested locally; build passes with no errors or warnings: make clean && make run: Builds and serves successfully make spelling: No spelling errors make woke: No inclusive language issues make linkcheck: No broken links <img width="1850" height="941" alt="image" src="https://github.com/user-attachments/assets/037c1a67-943f-4511-986c-ccc0a4a10705" /> ## Contributor checklist Please check that you have: - [x] self-reviewed the code in this PR - [x] added code comments, particularly in less straightforward areas - [ ] checked and added or updated relevant documentation - [ ] added or updated HTML meta descriptions for any new or modified documentation pages (see [#643](#643)) - N/A - [ ] verified that page title and headings accurately represent page content for new or modified documentation pages - N/A - [ ] checked and added or updated relevant release notes - [ ] added tests to verify effectiveness of this change Signed-off-by: Sharon Koech <sharon.koech@canonical.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the MicroCeph docs to the latest version of the Sphinx Stack (v2.0). It brings in updated tooling, and adds missing CI checks.
pyspellingmodule #678Key changes
conf.pywith the latest Sphinx Stack templatecla-check.yml,check-removed-urls.yml)requirements.txtredirects.txtsince Sphinx Stack 2.0 deprecates thesphinx-reredirectsextension, which defines redirects inline, in favor ofsphinx-rerediraffe, which requires redirects to live in a separateredirects.txtfileconf.pyFETCH_SCRIPTvariable fromSOURCEDIRtoDOCS_SOURCEDIRinMakefile_dev/directory with updated tooling (pre-commit hooks, Vale config, pa11y script, pymarkdown) - renamed from_.sphinxto better reflect its purpose (breaking change)reuse/directory to reduce complexity and improve source readability (breaking change)Features
sphinx-llmextension that generates extra files (llms.txt,llms-full.txt,.mdcopies of each page) alongside regular HTML build, that are optimized for AI tools. This makes the documentation consumable by LLMs and MCP-based tools.~=operator (compatible release), which locks to the current major version, which means that we'd still get minor updates (e.g., bug fixes, security fixes and minor improvements/features) without risking a surprise breaking change.html_contextinconf.py. Sphinx Stack 2.0 aligns the copyright statement with legal standardsRelease notes: https://github.com/canonical/sphinx-stack/releases
Type of change
How has this been tested?
Tested locally; builds pass with no errors or warnings:
make run: Builds and serves successfullymake spelling: No spelling errors; Ceph-specific terms caught added to.custom_wordlist.txtmake woke: No inclusive language issuesmake linkcheck: No broken linksContributor checklist