sphinx-sitemap 0.3.1

Sitemap generator for Sphinx

A Sphinx extension to silently generate a sitemaps.org compliant sitemap for the HTML version of your Sphinx Documentation.

Installing

Directly install via pip by using:

pip install sphinx_sitemap

Set the value of site_url in your Sphinx conf.py to the current base URL of your documentation. For example:

#site base url
site_url = 'https://my-site.com/docs/'

Add sphinx_sitemap to the extensions array in your Sphinx conf.py. For example:

extensions = ['sphinx_sitemap']

Maintaining PyPI Version

These are the steps for making a new Python package release.

1. Rev versions in sphinx_sitemap/version.py and setup.py.

2. Create a tag and push to GitHub:

   git tag -a vX.Y.Z -m "Release vX.Y.Z"
   git push --tags origin master
   

3. Upload the latest distribution:

   python setup.py sdist upload -r pypi
   

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 licensed under the MIT license.