sphinx-sitemap
Sitemap generator for Sphinx
Decision gist · record as of 2026-08-14
Yes. This is a lightweight, actively maintained Sphinx extension with no known vulnerabilities, permissive licensing, and a single runtime dependency. Install it if you host Sphinx documentation and want search engines to reliably discover all versions or language variants of your docs.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Low install friction with a single runtime dependency.
- Active maintenance as of August 2026, with consistent releases since 2017.
License · maintenance · safety
MIT (permissive) — MIT license permits unrestricted use, modification, and distribution in both open-source and proprietary projects.
last release 2025-10-06 (312 days) · last repo commit 2026-08-10 · 63 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 671,594 downloads/mo, #5,404 on PyPI
Alternatives
Verify before relying
pip install sphinx-sitemap
# In conf.py, add to extensions list:
extensions = ['sphinx_sitemap']
# Configure sitemap URL:
html_baseurl = 'https://example.com/docs/'- Whether the package handles dynamic content or requires static HTML generation first
- Performance characteristics with very large documentation sets or many language variants
What it is and what it does
sphinx-sitemap is a Sphinx extension that automatically generates XML sitemaps compatible with the sitemaps.org protocol for your HTML documentation builds. It handles the common case where documentation exists in multiple versions or languages, creating a single sitemap that search engines can use to discover and index all variants of your docs.
The package integrates directly into Sphinx's build process and requires minimal configuration—typically just setting your documentation's base URL. It depends on sphinx-last-updated-by-git to track when content was last modified, which feeds into sitemap metadata. The extension is permissively licensed under MIT and has been maintained since 2017.
Use it for
- Generate search-engine-discoverable sitemaps for multi-version documentation (e.g., docs for current and legacy releases)
- Create sitemaps for documentation available in multiple languages to ensure all variants are indexed
- Automatically include lastmod timestamps in sitemaps by tracking git commit history of documentation files
- Improve SEO for Sphinx-hosted documentation by providing structured sitemap metadata to search engines
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes.
This is a lightweight, actively maintained Sphinx extension with no known vulnerabilities, permissive licensing, and a single runtime dependency. Install it if you host Sphinx documentation and want search engines to reliably discover all versions or language variants of your docs.
Install
sphinx-sitemap on PyPI
Before you install
Low install friction with a single runtime dependency. Active maintenance as of August 2026, with consistent releases since 2017.
License in practice
MIT license permits unrestricted use, modification, and distribution in both open-source and proprietary projects.
Quickstart
pip install sphinx-sitemap
# In conf.py, add to extensions list:
extensions = ['sphinx_sitemap']
# Configure sitemap URL:
html_baseurl = 'https://example.com/docs/'Verify before relying
- Whether the package handles dynamic content or requires static HTML generation first
- Performance characteristics with very large documentation sets or many language variants
Package facts
| License | MIT permissive |
| Python support | Not specified |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packagesphinx-last-updated-by-git |
| Maintenance | Actively maintained 312 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 671,594 / month, #5,404 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Framework :: Sphinx :: ExtensionProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.9Topic :: Documentation :: Sphinx |
Evidence: sphinx_sitemap-2.9.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx sitemap generator”
- sphinx-sitemapGenerates sitemaps.org-compliant XML sitemaps for Sphinx…
- sphinx-llmSphinx extensions that generate LLM-consumable documentation formats…
- ultimate-sitemap-parserParses and crawls sitemaps in multiple formats (XML, RSS, Atom, plain…
Give your agent the search over MCP, or paste the wish link into any chat.
More Sphinx packages
Parses Python docstrings in ReST, Google, Numpydoc, and Epydoc formats, extracting structured information like descriptions, parameters, return types, and exceptions.
Install it if you need to programmatically read and extract structured data from Python docstrings.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
A Sphinx extension that converts documentation source files into QtHelp format, enabling integration with Qt-based help systems and documentation viewers.
However, be aware that maintenance is dormant—if you rely on it long-term, monitor Sphinx compatibility and consider whether QtHelp remains the right format for your…
See also ultimate-sitemap-parser · sphinx-llm · sphinx-multitoc-numbering · sphinxcontrib-napoleon · sphinx-bootstrap-theme · myst-parser