A Sphinx_ extension to generate multiversion and multilanguage
sitemaps.org_ compliant sitemaps for the HTML version of your Sphinx
documentation.
| |PyPI version| |Conda Forge| |Downloads| |Parallel Safe| | |Code style: Black| |Docs Build| |CI Workflow|
See sphinx-sitemap documentation_ for installation and configuration instructions.
Pull Requests welcome! See Contributing_ for instructions on how best to contribute.
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
FAQs
Sitemap generator for Sphinx
We found that sphinx-sitemap demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
npm now supports Trusted Publishing with OIDC, enabling secure package publishing directly from CI/CD workflows without relying on long-lived tokens.
Research
/Security News
A RubyGems malware campaign used 60 malicious packages posing as automation tools to steal credentials from social media and marketing tool users.
Security News
The CNA Scorecard ranks CVE issuers by data completeness, revealing major gaps in patch info and software identifiers across thousands of vulnerabilities.
