Skip to content

Documentation: Add and configure sphinx-sitemap extension#732

Merged
amotl merged 1 commit intomainfrom
sphinx-sitemap
Mar 29, 2026
Merged

Documentation: Add and configure sphinx-sitemap extension#732
amotl merged 1 commit intomainfrom
sphinx-sitemap

Conversation

@amotl
Copy link
Copy Markdown
Member

@amotl amotl commented Mar 29, 2026

For better discovery of all documentation ingredients.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 01f79e4a-be10-4eca-9d07-5519737f6f7c

📥 Commits

Reviewing files that changed from the base of the PR and between 6abcf81 and 3353dfc.

📒 Files selected for processing (2)
  • doc/conf.py
  • pyproject.toml
✅ Files skipped from review due to trivial changes (1)
  • doc/conf.py
🚧 Files skipped from review as they are similar to previous changes (1)
  • pyproject.toml

Walkthrough

Adds sitemap generation to the Sphinx documentation by enabling the sphinx_sitemap extension, setting html_baseurl and sitemap_url_scheme, and excluding specific pages and paths from the sitemap.

Changes

Cohort / File(s) Summary
Sphinx Documentation Configuration
doc/conf.py
Added sphinx_sitemap to extensions; set html_baseurl to https://cratedb-toolkit.readthedocs.io/; configured sitemap_url_scheme as {link}; added sitemap_excludes for search.html, genindex.html, and _snippet/*.
Project Dependencies
pyproject.toml
Added sphinx-sitemap<3 to optional-dependencies.docs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰
A sitemap hops into the light,
Linking docs from left to right.
Search and index take a nap,
While paths and snippets skip their map —
Hooray, the docs now have a trail! 🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding and configuring the sphinx-sitemap extension for documentation.
Description check ✅ Passed The description is related to the changeset, explaining the purpose of the sphinx-sitemap addition for better documentation discovery.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch sphinx-sitemap

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@amotl amotl marked this pull request as ready for review March 29, 2026 12:29
coderabbitai[bot]

This comment was marked as resolved.

@amotl amotl changed the title Documentation: Add sphinx-sitemap extension Documentation: Add and configure sphinx-sitemap extension Mar 29, 2026
@amotl amotl merged commit 83ca876 into main Mar 29, 2026
24 of 26 checks passed
@amotl amotl deleted the sphinx-sitemap branch March 29, 2026 12:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant