sphinx-sitemap
==============

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

|PyPI version| |Conda Forge| |Downloads| |Parallel Safe| |GitHub Stars|

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

.. toctree::
   :maxdepth: 2

   getting-started
   advanced-configuration
   search-optimization
   configuration-values
   contributing
   changelog


.. _sitemaps.org: https://www.sitemaps.org/protocol.html
.. _sitemap.xml: https://sphinx-sitemap.readthedocs.io/en/latest/sitemap.xml
.. _Sphinx: http://sphinx-doc.org/

.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-sitemap.svg
   :target: https://pypi.python.org/pypi/sphinx-sitemap
   :alt: Latest PyPi Version
.. |Conda Forge| image:: https://img.shields.io/conda/vn/conda-forge/sphinx-sitemap.svg
   :target: https://anaconda.org/conda-forge/sphinx-sitemap
   :alt: Latest Conda Forge version
.. |Downloads| image:: https://static.pepy.tech/badge/sphinx-sitemap/month
    :target: https://pepy.tech/project/sphinx-sitemap
    :alt: PyPi Downloads per month
.. |Parallel Safe| image:: https://img.shields.io/badge/parallel%20safe-true-brightgreen
   :target: #
   :alt: Parallel read/write safe
.. |GitHub Stars| image:: https://img.shields.io/github/stars/jdillard/sphinx-sitemap?style=social
   :target: https://github.com/jdillard/sphinx-sitemap
   :alt: GitHub Repository stars