build(docs): update build, add sphinx sitemap, update site links
Metadata
Current evaluation
Merged after two approvals and passing all CI checks. Updates docs build config, switches Sphinx to dirhtml for sitemap generation, adds a sitemap, updates site links, and standardizes tooling across five files.
Suggested action: —
No scores available.
Issue body
ROCKCRAFT-237
- Update site links.
- Also, do some small housekeeping in docs config file.
For ROCKCRAFT-238:
- Configure sitemap.
- Switch Sphinx builder to `dirhtml`, as it's required for sitemap
generation.
Other:
Make local and builds use the same consistent tooling.
---
- [x] Have you followed the guidelines for contributing?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `make lint && make test`?
---
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| qwen/qwen3.6-35b-a3b | — | — | Merged after two approvals and passing all CI checks. Updates docs build config, switches Sphinx to dirhtml for sitemap generation, adds a sitemap, updates site links, and standardizes tooling across five files. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Updates documentation build to add Sphinx sitemap generation via the dirhtml builder, refreshes site links, and standardizes local and CI tooling. All lint and test checks passed. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Updated documentation build tooling, switched Sphinx to dirhtml builder, configured sitemap generation, updated site links, and refined docs configuration per ROCKCRAFT-237 and ROCKCRAFT-238. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #5559 build(docs): update build, add sphinx sitemap, add feedback button | snapcraft | merged | Merged after reviewer approval and CI fixes. Updates the documentation build, adds a Sphinx sitemap and feedback button, switches to dirhtml builder, configures RTD builds, and refines docs configuration. | |
| #2323 build(docs): add sphinx sitemap | charmcraft | merged | Merged following approval from two reviewers. Integrated sphinx-sitemap as a documentation dependency, updated conf.py to generate a sitemap during builds, and switched local builds to the dirhtml builder. | |
| #158 build(docs): add sphinx sitemap | imagecraft | merged | Merged after adding sphinx-sitemap and switching local builds to the dirhtml builder. Reviewers approved the changes, and feedback regarding local URL schemes and a potential sitemap bug was addressed prior to merge. | |
| #404 build(docs): add sitemap generator | starbase | merged | Merged after two approvals and passing all CI checks. Integrates the sphinx-sitemap extension to generate custom sitemaps for RTD and local builds, fulfilling requirements for Canonical documentation projects. Modified 4 files (+38/-4). | |
| #65 docs: fix sphinx doc generation and update docstrings | craft-parts | merged | Merged after two approvals and passing CI. Fixed Sphinx doc generation by importing modules to resolve import cycles, and added missing parameter descriptions to docstrings across five files. | |
| #23 docs: use canonical-sphinx | craft-grammar | merged | Merged after two approvals and passing CI. Updates documentation to use canonical-sphinx, modifying 7 files with a net reduction of 72 lines. | |
| #720 docs: use canonical-sphinx | craft-parts | merged | Merged documentation update to adopt canonical-sphinx. Approved by two reviewers, the change modifies three files, removing 167 lines and adding 45 to standardize the build configuration. | |
| #4128 docs: set sphinx autobuild-docs to watch the correct directories | snapcraft | merged | Merged into main after two approvals and passing CI. Updates Sphinx autodoc configuration to monitor the correct directories, resolving issue #4123. Code coverage remained unchanged. | |
| #1501 build(docs): update and clean docs dependencies | craft-parts | merged | Merged following approval by three reviewers. Updated and cleaned documentation dependencies, removing sphinx-pydantic in favor of pydantic-kitbash. All required CI checks passed. | |
| #983 docs: update links | rockcraft | merged | Merged documentation update that replaces hardcoded URLs with intersphinx and Sphinx references, and fixes redirected external links. Approved by three reviewers and passed CI checks after resolving initial lint and test failures. |