build(docs): update build, add sphinx sitemap, update site links
Metadata
Current evaluation
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.
Resolution: closed resolved
Reason: The PR itself was merged into main as commit c1fea236 with all CI checks passing and approval from two reviewers. The sitemap configuration it added (sitemap_filename = 'doc-sitemap.xml', html_baseurl, sitemap_excludes) is present in docs/conf.py, and the dirhtml builder switch appears only in this commit.
Evaluated by: mr-cal-bot
No scores available.
Issue body
ROCKCRAFT-237
- Update site links.
- Also, do some small housekeeping in docs config file.
For ROCKCRAFT-238:
- Configure sitemap.
- Switch Sphinx builder to `dirhtml`, as it's required for sitemap
generation.
Other:
Make local and builds use the same consistent tooling.
---
- [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 | 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. | |
| stealth/space-bunny-alpha | — | closed resolved | Merged as canonical/rockcraft#900 (commit c1fea236), updating documentation links/build tooling, adding a sitemap, and switching Sphinx to dirhtml. | |
| qwen/qwen3.6-35b-a3b | — | — | 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. | |
| qwen3.6-35b-a3b-mtp-q6 | — | — | Merged. Updates documentation build to add Sphinx sitemap generation via the dirhtml builder, refreshes site links, and standardizes local and CI tooling. All lint and test checks passed. |
Update history
No update history recorded yet.
Related work
-
Related To:
canonical/rockcraft#1252
(confidence 62%)
Later commit caf0486f 'docs: update dependency sphinx stack to 2.0' bumps the Sphinx stack that this PR's sitemap extension now depends on.
-
Related To:
canonical/rockcraft#1333
(confidence 55%)
Commit d2705dd3 is the most recent change to the sitemap_filename setting this PR introduced, reworking docs configuration for ubuntu.com publication.
Related issues
| Issue | Project | State | Summary | Similarity |
|---|---|---|---|---|
| #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). | |
| #559 docs: use canonical-sphinx | rockcraft | merged | Merged PR #559 (commit 041e3137) switched Rockcraft docs to canonical-sphinx, added the dependency to setup.cfg, and regenerated requirements-doc.txt. | |
| #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. | |
| #300 docs: refactor documentation for sphinx-starter-pack | rockcraft | merged | Merged PR #300 in commit 66911e8e, refactoring 28 documentation files to align Rockcraft with sphinx-starter-pack and ease future integration. | |
| #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. | |
| #247 docs: include some docs from craft-parts | rockcraft | closed | PR pulling craft-parts docs into rockcraft was left unmerged and closed as redundant; the same docs refactor landed instead via rockcraft#515 (commit 5c2263f1, "refactor(docs): use more docs from craft-parts"). | |
| #2958 fix: update rockcraft documentation link to new url | charmcraft | merged | Merged PR #2958 updating legacy rockcraft documentation links from documentation.ubuntu.com to ubuntu.com/containers/rockcraft/docs across 10 files. | |
| #999 docs: release notes for 1.15.0 | rockcraft | merged | Merged #999, adding Rockcraft 1.15.0 release notes and documenting the sphinx-docs-starter-pack submodule rename; commit 319bb30a. | |
| #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. |