build(docs): update build, add sphinx sitemap, add feedback button
Metadata
Current evaluation
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.
Suggested action: —
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 |
|---|---|---|---|---|
| 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged after the build was fixed. Updates the documentation build, adds a Sphinx sitemap, switches to the dirhtml builder, and includes a feedback button. Configures RTD builds, adds copyright year, and hides the commit hash 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 | 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. | |
| #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). | |
| #513 build(docs): fix double build with docs-lint | starbase | merged | Merged a one-line fix resolving a double build issue during docs-lint by correcting a mistaken assumption about Sphinx's linter requirements. Approved by two reviewers, passed CI, and closed issue #512. | |
| #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. | |
| #4367 docs: update sphinx theme | snapcraft | merged | Merged documentation update for the Sphinx theme. Initial build failures were resolved by incorporating fixes from PR #4375 and minor adjustments. Approved by three reviewers, passed CI, and merged into main. | |
| #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. | |
| #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. | |
| #275 build(docs): incorporate the latest Sphinx Starter Pack | imagecraft | merged | Merged the latest Sphinx Starter Pack into the documentation build configuration. Approved by three reviewers. Initial CI failures on fast tests and builds were deemed unrelated by the maintainer, and the changes were successfully merged across 23 files. |