Sitemap generator for Sphinx
Project description
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.
Rev versions in sphinx_sitemap/version.py and setup.py.
Create a tag and push to GitHub:
git tag -a vX.Y.Z -m "Release vX.Y.Z" git push --tags origin master
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file sphinx-sitemap-0.3.1.tar.gz
.
File metadata
- Download URL: sphinx-sitemap-0.3.1.tar.gz
- Upload date:
- Size: 3.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
b5a8c98b3f2b525846d7c49fa69f7e1a69a542db87e7bc39bcc0626170f3507e
|
|
MD5 |
91ab9bf6c98689117cbcfff922ea03d3
|
|
BLAKE2b-256 |
dc2ed193337fdff4247b0d08997bd04acd452cd95b427ee9071955b45866b1a1
|