https://github.com/jdillard/sphinx-sitemap

Sphinx extension to generate a multi-lingual, multi-version sitemap for HTML builds
https://github.com/jdillard/sphinx-sitemap

conda-forge sphinx sphinx-extension

Last synced: 5 days ago
JSON representation

Sphinx extension to generate a multi-lingual, multi-version sitemap for HTML builds

• Host: GitHub
• URL: https://github.com/jdillard/sphinx-sitemap
• Owner: jdillard
• License: mit
• Created: 2017-08-18T00:34:41.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-09-16T20:07:10.000Z (about 2 months ago)
• Last Synced: 2024-09-17T01:35:00.207Z (about 2 months ago)
• Topics: conda-forge, sphinx, sphinx-extension
• Language: Python
• Homepage: https://sphinx-sitemap.readthedocs.io/en/latest/index.html
• Size: 204 KB
• Stars: 55
• Watchers: 5
• Forks: 21
• Open Issues: 15
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - jdillard/sphinx-sitemap - Sphinx extension to generate a multi-lingual, multi-version sitemap for HTML builds (others)

README

        
Sphinx Sitemap Generator Extension

==================================

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|

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