sphinx-sitemap


Namesphinx-sitemap JSON
Version 2.7.1 PyPI version JSON
download
home_pageNone
SummarySitemap generator for Sphinx
upload_time2025-06-21 05:42:02
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            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

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "sphinx-sitemap",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": "Jared Dillard <jared.dillard@gmail.com>",
    "keywords": null,
    "author": null,
    "author_email": "Jared Dillard <jared.dillard@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/f2/78/b1ea32670915ce6b04cffe837a5c863264ec528e6925b0c4b5ba077331c9/sphinx_sitemap-2.7.1.tar.gz",
    "platform": null,
    "description": "Sphinx Sitemap Generator Extension\n==================================\n\nA `Sphinx`_ extension to generate multiversion and multilanguage\n`sitemaps.org`_ compliant sitemaps for the HTML version of your Sphinx\ndocumentation.\n\n| |PyPI version| |Conda Forge| |Downloads| |Parallel Safe|\n| |Code style: Black| |Docs Build| |CI Workflow|\n\nDocumentation\n-------------\n\nSee `sphinx-sitemap documentation`_ for installation and configuration instructions.\n\nContributing\n------------\n\nPull Requests welcome! See `Contributing`_ for instructions on how best to contribute.\n\nLicense\n-------\n\n**sphinx-sitemap** is made available under a **MIT license**; see `LICENSE`_ for\ndetails.\n\nOriginally based on the sitemap generator in the `guzzle_sphinx_theme`_ project,\nalso licensed under the MIT license.\n\n.. _Contributing: https://sphinx-sitemap.readthedocs.io/en/latest/contributing.html\n.. _guzzle_sphinx_theme: https://github.com/guzzle/guzzle_sphinx_theme\n.. _LICENSE: LICENSE\n.. _Sphinx: http://sphinx-doc.org/\n.. _sitemaps.org: https://www.sitemaps.org/protocol.html\n.. _sphinx-sitemap documentation: https://sphinx-sitemap.readthedocs.io/en/latest/index.html\n\n.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-sitemap.svg\n   :target: https://pypi.python.org/pypi/sphinx-sitemap\n.. |Conda Forge| image:: https://img.shields.io/conda/vn/conda-forge/sphinx-sitemap.svg\n   :target: https://anaconda.org/conda-forge/sphinx-sitemap\n.. |Downloads| image:: https://static.pepy.tech/badge/sphinx-sitemap/month\n    :target: https://pepy.tech/project/sphinx-sitemap\n.. |Code style: Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n   :target: https://github.com/psf/black\n.. |Parallel Safe| image:: https://img.shields.io/badge/parallel%20safe-true-brightgreen\n   :target: #\n.. |Docs Build| image:: https://readthedocs.org/projects/sphinx-sitemap/badge/?version=latest\n   :target: https://sphinx-sitemap.readthedocs.io/en/latest/?badge=latest\n   :alt: Documentation Status\n.. |CI Workflow| image:: https://github.com/jdillard/sphinx-sitemap/actions/workflows/continuous-integration.yml/badge.svg\n   :target: https://github.com/jdillard/sphinx-sitemap/actions/workflows/continuous-integration.yml\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Sitemap generator for Sphinx",
    "version": "2.7.1",
    "project_urls": {
        "changelog": "https://github.com/jdillard/sphinx-sitemap/blob/master/CHANGELOG.rst",
        "documentation": "https://sphinx-sitemap.readthedocs.io/en/latest/index.html",
        "download": "https://pypi.org/project/sphinx-sitemap/",
        "source": "https://github.com/jdillard/sphinx-sitemap"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "198cd1c065b83d16f5649afac8d677c2b5ea35c43b5bb5ee5c71a8e19e71dd22",
                "md5": "c12cda38b1745bbcdb743d1c71bd4392",
                "sha256": "7dd848f747a7fd34d75ab14ac0938f5740dc72c222c93653ae740223f63dd1bf"
            },
            "downloads": -1,
            "filename": "sphinx_sitemap-2.7.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c12cda38b1745bbcdb743d1c71bd4392",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 6041,
            "upload_time": "2025-06-21T05:42:01",
            "upload_time_iso_8601": "2025-06-21T05:42:01.109940Z",
            "url": "https://files.pythonhosted.org/packages/19/8c/d1c065b83d16f5649afac8d677c2b5ea35c43b5bb5ee5c71a8e19e71dd22/sphinx_sitemap-2.7.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "f278b1ea32670915ce6b04cffe837a5c863264ec528e6925b0c4b5ba077331c9",
                "md5": "1e2a1a0bd11edccb7b2e1c5f5b46bc2d",
                "sha256": "28f02df7062e83628e9782a0d9449658a79c9813217c51db086edc51f20e7bd5"
            },
            "downloads": -1,
            "filename": "sphinx_sitemap-2.7.1.tar.gz",
            "has_sig": false,
            "md5_digest": "1e2a1a0bd11edccb7b2e1c5f5b46bc2d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6424,
            "upload_time": "2025-06-21T05:42:02",
            "upload_time_iso_8601": "2025-06-21T05:42:02.344152Z",
            "url": "https://files.pythonhosted.org/packages/f2/78/b1ea32670915ce6b04cffe837a5c863264ec528e6925b0c4b5ba077331c9/sphinx_sitemap-2.7.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-06-21 05:42:02",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jdillard",
    "github_project": "sphinx-sitemap",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "sphinx-sitemap"
}
        
Elapsed time: 0.95909s