sphinx-sitemap

A Sphinx extension to generate multi-version and multi-language sitemaps.org compliant sitemaps for the HTML version of your Sphinx documentation.

Demo

You can see this Sphinx project’s sitemap.xml as a simple example.

Highlights

1. Multi-version Support: Generates sitemaps for multiple documentation versions

2. Multi-language Support: Creates sitemaps for multiple language variants of your documentation

3. Content Exclusion: Allows you to exclude specific pages or patterns from the sitemap

4. Last Modified Support: Includes lastmod timestamps to help understand content freshness

5. AI & RAG Optimization: Helps AI systems discover and index your documentation content

6. SEO Optimization: Improves search engine discoverability of your documentation

• Getting Started
  • Installation
  • Usage
• Advanced Configuration
  • Customizing the URL Scheme
  • Changing the Filename
  • Version Support
  • Language Support
  • Excluding Pages
  • Adding Last Modified Timestamps
  • Formatting XML Output
• Getting the Most out of the Sitemap
  • Search Engine Optimization
  • Site Search Optimization
  • RAG (Retrieval-Augmented Generation) Ingestion
• Project Configuration Values
• Contributing
  • Local development
  • Install a local copy of the extension
  • Testing changes
  • Current contributors
• Changelog
  • 2.9.0
  • 2.8.0
  • 2.7.2
  • 2.7.1
  • 2.7.0
  • 2.6.0
  • 2.5.1
  • 2.5.0
  • 2.4.0
  • 2.3.0
  • 2.2.1
  • 2.2.0
  • 2.1.0
  • 2.0.0
  • 1.1.0
  • 1.0.2
  • 1.0.1
  • 1.0.0
  • 0.3.1
  • 0.3.0
  • 0.2
  • 0.1