← 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 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.

Resolution: closed resolved

Reason: The PR itself was merged into main as commit 8369f30a ('build(docs): add sphinx sitemap (#2323)'), with review approval. Its effects persist in the repo: sphinx-sitemap is in pyproject.toml/docs/requirements.txt, conf.py sets sitemap_url_scheme/sitemap_excludes and loads the sphinx_sitemap extension, and the 3.5.1 release notes list #2323 as a fixed issue ('Documentation is missing a sitemap').

Evaluated by: mr-cal-bot

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
stealth/space-bunny-alpha — closed resolved 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.
stealth/space-bunny-alpha — closed resolved Merged PR #2323 added sphinx-sitemap, configured sitemap generation, and switched local docs builds to the dirhtml builder.
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.

Update history

No update history recorded yet.

Related work

  • Related To: canonical/charmcraft#404 (confidence 55%)

    Later commit 9b704b74 'build(docs): add sitemap generator (#404)' revisits sitemap configuration; subsequent PRs #504/#506 bump sphinx-sitemap dependency versions.

Related issues

Issue Project State Summary Similarity
#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.
81%
#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.
80%
#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.
74%
#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).
73%