build(docs): add sphinx sitemap
Metadata
Current evaluation
Merged in canonical/imagecraft#158 (commit 6be8578), adding sphinx-sitemap, generating sitemaps during documentation builds, and using dirhtml locally.
Resolution: closed resolved
Reason: PR #158 was merged as commit 6be8578. The final changes add the sitemap dependency and configuration and switch local docs builds to dirhtml, addressing the URL-format concern raised in review.
Evaluated by: mr-cal-bot
No scores available.
Issue body
- [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`?
---
IMAGECRAFT-26
* Adds `sphinx-sitemap` as a docs dependency
* Modifies `conf.py` to generate a site map during build
* Switches local builds to the `dirhtml` builder
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/imagecraft#158 (commit 6be8578), adding sphinx-sitemap, generating sitemaps during documentation builds, and using dirhtml locally. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged the docs sitemap update: added sphinx-sitemap, generated sitemaps during builds, and switched local docs to the dirhtml builder (commit f431e27). | |
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Added sphinx-sitemap as a dependency and updated conf.py to generate site maps. Switched local builds to the dirhtml builder. A potential bug with local URL paths was noted but did not prevent the merge. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #404 build(docs): add sitemap generator | starbase | merged | Merged #404, adding sphinx-sitemap to generate custom sitemaps for Read the Docs and local builds in the documentation output directory. | |
| #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). | |
| #676 build(deps): bump canonical-sphinx to 0.2.0 | craft-providers | merged | Merged PR #676 updated canonical-sphinx to 0.2.0, enabling the new documentation grid template; landed as commit 6d2dda7. | |
| #65 docs: fix sphinx doc generation and update docstrings | craft-parts | merged | Merged in canonical/craft-parts#65 via a5373f23, fixing Sphinx type-hint import cycles and adding missing docstring parameter descriptions. | |
| #106 docs: use canonical-sphinx | craft-archives | merged | Merged PR #106 switched the documentation build to canonical-sphinx in commit 9f73ab6. | |
| #720 docs: use canonical-sphinx | craft-parts | merged | Merged PR #720 as commit 278feb8d, migrating craft-parts docs to canonical-sphinx and removing legacy configuration across three files. | |
| #562 docs: update to canonical-sphinx | craft-providers | merged | Merged PR (commit 9897239) enabled the canonical-sphinx docs extension and removed sphinx-docs-starter-pack submodule references in craft-providers. Leftover submodule dir was later cleaned up in #713. | |
| #209 docs: use canonical-sphinx | starbase | merged | Merged PR #209 (commit cd48e13) migrated the documentation build from legacy Sphinx configuration to canonical-sphinx. |