← Back to issue list

build(docs): add sphinx sitemap

View original Github issue

Metadata

Project
charmcraft
Number
#2323
Type
pull request
State
merged
Author
jahn-junior
Labels
Created
Updated
Closed

Current evaluation

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.

Suggested action:

No scores available.

Issue body

* Adds `sphinx-sitemap` as a docs dependency * Modifies `conf.py` to generate a sitemap during build * Switches local builds to the `dirhtml` builder [sitemap.xml](https://canonical-charmcraft--2323.com.readthedocs.build/2323/sitemap.xml)

Evaluation history

Date Model Scores Action Summary
qwen/qwen3.6-35b-a3b 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.
qwen3.6-35b-a3b-mtp-q6 Merged by jahn-junior. Added sphinx-sitemap as a docs dependency, updated conf.py to generate sitemaps during builds, and switched local builds to the dirhtml builder.
qwen3.6-35b-a3b-mtp-q6 Merged by jahn-junior 376 days ago. Added sphinx-sitemap as a docs dependency, updated conf.py to generate sitemaps during builds, and switched local builds to the dirhtml builder. The change is live and verified.

Update history

No update history recorded yet.

Related issues

Issue Project State Summary Similarity
#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.
90%
#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.
85%
#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.
84%
#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).
83%
#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.
75%
#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.
75%
#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.
74%
#506 build(deps): update dependency sphinx-sitemap to v2.9.0 (main) starbase merged Merged an automated dependency update by Renovate Bot, upgrading sphinx-sitemap from v2.6.0 to v2.9.0. Approved by two reviewers and passing all CI checks, the change was successfully integrated into the main branch.
74%
#249 docs: use canonical-sphinx extension craft-cli merged Merged following approval by two reviewers. The change integrates the canonical-sphinx extension into the documentation build system, updating 22 files and removing over 1000 lines of legacy configuration.
73%
#4766 docs: use canonical-sphinx snapcraft merged Merged documentation update switching to canonical-sphinx. Consolidated requirements files and added docs_requires to setup.py. Approved by two reviewers with passing CI checks.
73%