{ "info": { "author": "Jared Dillard", "author_email": "jared.dillard@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3", "Topic :: Documentation" ], "description": "Sphinx Sitemap Generator Extension\n==================================\n\nA `Sphinx`_ extension to silently generate a `sitemaps.org`_ compliant sitemap for\nthe HTML version of your Sphinx Documentation.\n\n|Build Status| |PyPI version| |License: MIT|\n\nInstalling\n----------\n\nDirectly install via pip by using::\n\n pip install sphinx-sitemap\n\nAdd ``sphinx_sitemap`` to the `extensions`_ array in your Sphinx **conf.py**.\nFor example::\n\n extensions = ['sphinx_sitemap']\n\nSet the value of `html_baseurl`_ in your Sphinx **conf.py** to the current\nbase URL of your documentation with a trailing slash. For example::\n\n html_baseurl = 'https://my-site.com/docs/'\n\nMultilingual Configuration\n^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nFor multilingual sitemaps, you have to generate a sitemap per language/locale\nand then manually add their locations to a `sitemapindex`_ file.\n\nThe extension will look at the `language`_ config value for the current language\nbeing built, and the `locale_dirs`_ value for the directory for alternate languages,\nso make sure those are set.\n\n**Note:** The extension is currently opinionated, in that it will also use the\n`version`_ config value in the generated URL. Setting it to ``latest`` is appropriate\nfor most use cases.\n\nThe end result is something like the following for each language/version build::\n\n \n \n \n https://my-site.com/docs/en/latest/index.html\n \n \n \n \n \n https://my-site.com/docs/en/latest/about.html\n \n \n \n \n \n \nGetting the Most out of the Sitemap\n-----------------------------------\n\n#. Add a **robots.txt** file in the **source** directory which contains a link to\n the sitemap or sitemapindex. For example::\n\n User-agent: *\n\n Sitemap: https://my-site.com/docs/sitemap.xml\n \n \n Then, add **robots.txt** to the `html_extra_path`_ config value::\n\n html_extra_path = ['robots.txt']\n \n#. Submit the sitemap or sitemapindex to the appropriate search engine tools.\n\nSee Who Is Using It\n-------------------\n\nYou can use `GitHub search`_ or `libraries.io`_ to see who is using **sphinx-sitemap**.\n\nContributing\n------------\n\nPull Requests welcome! See `CONTRIBUTING`_ for instructions on how best to contribute.\n\nMaintaining PyPI Version\n------------------------\n\nThese are the steps, to be run by the maintainer, for making a new Python package release.\n\n#. Rev versions in **sphinx_sitemap/version.py** and **setup.py**.\n#. Update **CHANGELOG.md**\n#. Create a tag and push to GitHub::\n\n git tag -a vX.Y.Z -m \"Release vX.Y.Z\"\n git push --tags origin master\n\n#. Create latest distribution locally::\n\n python setup.py sdist\n \n#. Upload to the test pypi.org repository::\n\n twine upload --repository-url https://test.pypi.org/legacy/ dist/*\n \n#. Upload to the production pypi.org repository::\n\n twine upload dist/*\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: CONTRIBUTING.md\n.. _extensions: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-extensions\n.. _GitHub search: https://github.com/search?utf8=%E2%9C%93&q=sphinx-sitemap+extension%3Atxt&type=\n.. _guzzle_sphinx_theme: https://github.com/guzzle/guzzle_sphinx_theme\n.. _html_baseurl: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl\n.. _html_extra_path: http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_extra_path\n.. _language: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-language\n.. _libraries.io: https://libraries.io/pypi/sphinx-sitemap\n.. _LICENSE: LICENSE\n.. _locale_dirs: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-locale_dirs\n.. _sitemapindex: https://support.google.com/webmasters/answer/75712?hl=en\n.. _sitemaps.org: https://www.sitemaps.org/protocol.html\n.. _Sphinx: http://sphinx-doc.org/\n.. _version: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-version\n\n.. |Build Status| image:: https://travis-ci.org/jdillard/sphinx-sitemap.svg?branch=master\n :target: https://travis-ci.org/jdillard/sphinx-sitemap\n.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-sitemap.svg\n :target: https://pypi.python.org/pypi/sphinx-sitemap\n.. |License: MIT| image:: https://img.shields.io/badge/License-MIT-blue.svg\n :target: https://github.com/jdillard/sphinx-sitemap/blob/master/LICENSE", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/jdillard/sphinx-sitemap/archive/v1.0.2.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/jdillard/sphinx-sitemap", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "sphinx-sitemap", "package_url": "https://pypi.org/project/sphinx-sitemap/", "platform": "", "project_url": "https://pypi.org/project/sphinx-sitemap/", "project_urls": { "Download": "https://github.com/jdillard/sphinx-sitemap/archive/v1.0.2.tar.gz", "Homepage": "https://github.com/jdillard/sphinx-sitemap" }, "release_url": "https://pypi.org/project/sphinx-sitemap/1.0.2/", "requires_dist": null, "requires_python": "", "summary": "Sitemap generator for Sphinx", "version": "1.0.2" }, "last_serial": 4800956, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "c135ad1657d454f2f45c7d0b87b8a560", "sha256": "5a57c3432a9aef88f6ca14be6da62be26221e3908130364f614ef32d7db6f6f2" }, "downloads": -1, "filename": "sphinx-sitemap-0.1.tar.gz", "has_sig": false, "md5_digest": "c135ad1657d454f2f45c7d0b87b8a560", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2658, "upload_time": "2017-11-28T23:01:49", "url": "https://files.pythonhosted.org/packages/41/ac/3ef12d64eca3dcab976e08826c56cbe731bc7c3e5eede4e67ca440f86072/sphinx-sitemap-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "2c06c48367a7e93c5f4d9748e29dd72b", "sha256": "0a8a556c5246eb1662341a36037948235ebf54429cb1faea231083fd2d163d1f" }, "downloads": -1, "filename": "sphinx-sitemap-0.2.tar.gz", "has_sig": false, "md5_digest": "2c06c48367a7e93c5f4d9748e29dd72b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2935, "upload_time": "2017-11-28T23:29:06", "url": "https://files.pythonhosted.org/packages/4b/44/0c6996412c88585d1df8a1b39fc72a5df82a47e69990f5ecc7e196961500/sphinx-sitemap-0.2.tar.gz" } ], "0.3.1": [ { "comment_text": "", "digests": { "md5": "91ab9bf6c98689117cbcfff922ea03d3", "sha256": "b5a8c98b3f2b525846d7c49fa69f7e1a69a542db87e7bc39bcc0626170f3507e" }, "downloads": -1, "filename": "sphinx-sitemap-0.3.1.tar.gz", "has_sig": false, "md5_digest": "91ab9bf6c98689117cbcfff922ea03d3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3041, "upload_time": "2018-03-04T21:21:25", "url": "https://files.pythonhosted.org/packages/dc/2e/d193337fdff4247b0d08997bd04acd452cd95b427ee9071955b45866b1a1/sphinx-sitemap-0.3.1.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "4a230633680ec2f069c1c3d5cc8cc160", "sha256": "2d1f1c17af44cb17d476e735b73c0d2c37b5b468c2557ef700c5a299e3eb844d" }, "downloads": -1, "filename": "sphinx-sitemap-1.0.1.tar.gz", "has_sig": false, "md5_digest": "4a230633680ec2f069c1c3d5cc8cc160", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4247, "upload_time": "2019-01-18T07:34:22", "url": "https://files.pythonhosted.org/packages/1d/fb/010aca94e9232102a1f81b51f5dc3a764f884e570bf26a333fbab90d72ac/sphinx-sitemap-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "79d9eb5d2a3ec34ba4ea77de23cadc4c", "sha256": "cc48046fb29d8aabc2cc4c5278d2f1a00a50613418bc51eb611a9528a9db5cfa" }, "downloads": -1, "filename": "sphinx-sitemap-1.0.2.tar.gz", "has_sig": false, "md5_digest": "79d9eb5d2a3ec34ba4ea77de23cadc4c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4715, "upload_time": "2019-02-10T01:48:57", "url": "https://files.pythonhosted.org/packages/ca/c2/d01ada252686cc2f4414fa895b52981f5ee4965b3026533751a18038cd66/sphinx-sitemap-1.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "79d9eb5d2a3ec34ba4ea77de23cadc4c", "sha256": "cc48046fb29d8aabc2cc4c5278d2f1a00a50613418bc51eb611a9528a9db5cfa" }, "downloads": -1, "filename": "sphinx-sitemap-1.0.2.tar.gz", "has_sig": false, "md5_digest": "79d9eb5d2a3ec34ba4ea77de23cadc4c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4715, "upload_time": "2019-02-10T01:48:57", "url": "https://files.pythonhosted.org/packages/ca/c2/d01ada252686cc2f4414fa895b52981f5ee4965b3026533751a18038cd66/sphinx-sitemap-1.0.2.tar.gz" } ] }