build(docs): add sphinx sitemap
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged after adding sphinx-sitemap as a dependency and updating conf.py to generate sitemaps. Local builds were switched to the dirhtml builder. A potential bug with dirhtml and local URL paths was discussed but did not block the merge. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #900 build(docs): update build, add sphinx sitemap, update site links | rockcraft | merged | 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. | |
| #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. | |
| #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). | |
| #504 build(deps): update dependency sphinx-sitemap to ==2.6.0 | starbase | merged | Merged update of sphinx-sitemap to version 2.6.0, resolving a build issue where sphinx-last-updated-by-git was incorrectly pulled in. Approved by two reviewers and merged despite bypassed QA failures caused by fork usage. | |
| #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. | |
| #820 docs(build): switch to extensionless URLs | rockcraft | merged | Merged a pull request that switches to extensionless URLs by forcing Sphinx to use the dirhtml builder for clean URLs. The change was approved by reviewers and passed CI checks. |