Sphinx Sitemap Generator Extension
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.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-sitemap 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx-sitemap-0.3.1.tar.gz | 3.0 kB | Without provenance | Details for sphinx-sitemap-0.3.1.tar.gz |
Release files / sphinx-sitemap-0.3.1.tar.gz
| Download URL | sphinx-sitemap-0.3.1.tar.gz |
|---|---|
| Size | 3.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
b5a8c98b3f2b525846d7c49fa69f7e1a69a542db87e7bc39bcc0626170f3507e
|
|
BLAKE2b-256 checksum How to use checksums |
dc2ed193337fdff4247b0d08997bd04acd452cd95b427ee9071955b45866b1a1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for sphinx-sitemap 0.3.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
