build(docs): add sitemap generator
Metadata
Current evaluation
Merged #404, adding sphinx-sitemap to generate custom sitemaps for Read the Docs and local builds in the documentation output directory.
Resolution: closed resolved
Reason: PR canonical/starbase#404 was approved by two reviewers, passed all CI checks, and was merged. Its sitemap configuration remains in docs/conf.py.
Evaluated by: mr-cal-bot
No scores available.
Issue body
Uses the sphinx-sitemap extension. Generates a custom sitemap for RTD and local builds and delivers it to the docs build directory.
Needed for all Canonical documentation projects.
---
- [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 |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged #404, adding sphinx-sitemap to generate custom sitemaps for Read the Docs and local builds in the documentation output directory. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged canonical/starbase#404, adding sphinx-sitemap and custom sitemap output for Read the Docs and local documentation builds. | |
| qwen/qwen3.6-35b-a3b | — | — | 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). | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Integrates the sphinx-sitemap extension to generate custom sitemaps for Read the Docs and local builds, delivering them to the docs directory. Passes all lint and test checks. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #158 build(docs): add sphinx sitemap | imagecraft | merged | Merged in canonical/imagecraft#158 (commit 6be8578), adding sphinx-sitemap, generating sitemaps during documentation builds, and using dirhtml locally. | |
| #2323 build(docs): add sphinx sitemap | charmcraft | merged | Merged to main (commit 8369f30a): adds sphinx-sitemap docs dependency, generates sitemap.xml in conf.py, switches local builds to dirhtml. Docs sitemap shipped in Charmcraft 3.5.1. | |
| #900 build(docs): update build, add sphinx sitemap, update site links | rockcraft | merged | PR #900 merged as commit c1fea236 (ROCKCRAFT-237/238): updated the docs build, added sphinx-sitemap with the dirhtml builder, refreshed site links, and aligned local/CI docs tooling. | |
| #5559 build(docs): update build, add sphinx sitemap, add feedback button | snapcraft | merged | Merged docs build overhaul adding feedback, a Sphinx sitemap, dirhtml, consistent RTD tooling, and housekeeping; landed as commit 24f5da833 (#5559). |