build(docs): update build, add sphinx sitemap, add feedback button
Metadata
Current evaluation
Merged docs build overhaul adding feedback, a Sphinx sitemap, dirhtml, consistent RTD tooling, and housekeeping; landed as commit 24f5da833 (#5559).
Resolution: closed resolved
Reason: PR #5559 was merged after approval. Commit 24f5da833 added the documentation feedback button, sphinx-sitemap dependency and configuration, dirhtml output, and aligned Read the Docs with local builds.
Evaluated by: mr-cal-bot
No scores available.
Issue body
For SNAPCRAFT-1155:
- Add feedback button.
For SNAPCRAFT-1158:
- Add dependency sphinx-sitemap to 'docs' group.
- Configure sitemap.
- Switch Sphinx builder to `dirhtml`, as it's required for sitemap generation.
Other:
- Configure RTD platform builds to call `make docs`. Make local and builds use the same consistent tooling.
- Add initial copyright year.
- Hide commit hash from version in local builds.
- Some housekeeping of the docs config file.
---
- [x] Have you followed the [guidelines for contributing](https://github.com/canonical/snapcraft/blob/main/CONTRIBUTING.md)?
- [x] Have you signed the [CLA](http://www.ubuntu.com/legal/contributors/)?
- [x] Have you successfully run `make lint`?
- [x] Have you successfully run `make test`?
---
Evaluation history
| Date | Model | Scores | Action | Summary |
|---|---|---|---|---|
| stealth/space-bunny-alpha | — | closed resolved | Merged docs build overhaul adding feedback, a Sphinx sitemap, dirhtml, consistent RTD tooling, and housekeeping; landed as commit 24f5da833 (#5559). | |
| stealth/space-bunny-alpha | — | closed resolved | Merged in canonical/snapcraft#5559 (24f5da833), updating docs builds, adding a Sphinx sitemap and feedback button, switching to dirhtml, and configuring RTD to run make docs. | |
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged after a build fix. Adds sphinx-sitemap, switches Sphinx to dirhtml builder, and adds a feedback button. Configures RTD builds for consistent tooling, updates copyright years, and hides commit hashes in local builds. |
Update history
No update history recorded yet.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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. | |
| #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. | |
| #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. | |
| #4367 docs: update sphinx theme | snapcraft | merged | Merged as commit aa64666ef, updating the Sphinx documentation theme; it replaced earlier attempt #4263 and picked up the #4375 fixes that restored broken doc builds. |