Sphinx Sitemap Generator Extension

A Sphinx_ extension to generate multiversion and multilanguage
sitemaps.org_ compliant sitemaps for the HTML version of your Sphinx
documentation.

Documentation

See sphinx-sitemap documentation_ for installation and configuration instructions.

Contributing

Pull Requests welcome! See Contributing_ for instructions on how best to contribute.

License

sphinx-sitemap is made available under a MIT license; see LICENSE_ for
details.

Originally based on the sitemap generator in the guzzle_sphinx_theme_ project,
also licensed under the MIT license.

.. _Contributing: https://sphinx-sitemap.readthedocs.io/en/latest/contributing.html
.. _guzzle_sphinx_theme: https://github.com/guzzle/guzzle_sphinx_theme
.. _LICENSE: LICENSE
.. _Sphinx: http://sphinx-doc.org/
.. _sitemaps.org: https://www.sitemaps.org/protocol.html
.. _sphinx-sitemap documentation: https://sphinx-sitemap.readthedocs.io/en/latest/index.html

.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-sitemap.svg
:target: https://pypi.python.org/pypi/sphinx-sitemap
.. |Conda Forge| image:: https://img.shields.io/conda/vn/conda-forge/sphinx-sitemap.svg
:target: https://anaconda.org/conda-forge/sphinx-sitemap
.. |Downloads| image:: https://static.pepy.tech/badge/sphinx-sitemap/month
:target: https://pepy.tech/project/sphinx-sitemap
.. |Code style: Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. |Parallel Safe| image:: https://img.shields.io/badge/parallel%20safe-true-brightgreen
:target: #
.. |Docs Build| image:: https://readthedocs.org/projects/sphinx-sitemap/badge/?version=latest
:target: https://sphinx-sitemap.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |CI Workflow| image:: https://github.com/jdillard/sphinx-sitemap/actions/workflows/continuous-integration.yml/badge.svg
:target: https://github.com/jdillard/sphinx-sitemap/actions/workflows/continuous-integration.yml

Dependency	Optional
sphinx-last-updated-by-git	false
build	true
flake8	true
pre-commit	true
pytest	true
sphinx	true
tox	true

Package profile

sphinx-sitemap

Releases

Release table

PyPI Downloads

Dependencies

Details

Project URLs

Dependencies

Package description