Docs: migrate Sphinx docs starter-pack to latest extension (infra) #2054
Conversation
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
The starter-pack has been upgraded to the extension-based version: more tooling supports are provided and most styling configurations are centralized in the canonical-sphinx extension. This upgrade uses the extension v5.1.0, and the starter-pack 1.2.0 https://github.com/canonical/sphinx-docs-starter-pack/releases/tag/1.2.0
Collaborator
Author
|
Fixed |
Hook25
approved these changes
Aug 8, 2025
stanley31huang
pushed a commit
that referenced
this pull request
Aug 14, 2025
…2054) * Migrate docs starter-pack to extension version 1.2.0 The starter-pack has been upgraded to the extension-based version: more tooling supports are provided and most styling configurations are centralized in the canonical-sphinx extension. This upgrade uses the extension v5.1.0, and the starter-pack 1.2.0 https://github.com/canonical/sphinx-docs-starter-pack/releases/tag/1.2.0 * Update Makefile to the latest version * update conf.py to latest and clean up requirements * update spelling wordlist and doc fix * add release version to title * black formatting * update doc check workflow to use new tooling * build readthedocs only upon docs changes * remove unused docs scripts: metrics and update
bladernr
pushed a commit
that referenced
this pull request
Aug 28, 2025
…2054) * Migrate docs starter-pack to extension version 1.2.0 The starter-pack has been upgraded to the extension-based version: more tooling supports are provided and most styling configurations are centralized in the canonical-sphinx extension. This upgrade uses the extension v5.1.0, and the starter-pack 1.2.0 https://github.com/canonical/sphinx-docs-starter-pack/releases/tag/1.2.0 * Update Makefile to the latest version * update conf.py to latest and clean up requirements * update spelling wordlist and doc fix * add release version to title * black formatting * update doc check workflow to use new tooling * build readthedocs only upon docs changes * remove unused docs scripts: metrics and update
stanley31huang
pushed a commit
that referenced
this pull request
Oct 3, 2025
…2054) * Migrate docs starter-pack to extension version 1.2.0 The starter-pack has been upgraded to the extension-based version: more tooling supports are provided and most styling configurations are centralized in the canonical-sphinx extension. This upgrade uses the extension v5.1.0, and the starter-pack 1.2.0 https://github.com/canonical/sphinx-docs-starter-pack/releases/tag/1.2.0 * Update Makefile to the latest version * update conf.py to latest and clean up requirements * update spelling wordlist and doc fix * add release version to title * black formatting * update doc check workflow to use new tooling * build readthedocs only upon docs changes * remove unused docs scripts: metrics and update
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
/sitemap.xmlavailable after online and local builds)docs/conf.pyto match the new versiondocs/Makefileto match the new version, existing targets remain unchangedpyspelltovale,docs/.sphinx/wordlist.txt-->docs/.custom_wordlist.txtResolved issues
CHECKBOX-1769
Documentation
UI update (new header and slgiht styling changes):
Tests
PR checks