git timestamp generator for Sphinx
Project description
A Sphinx extension that inserts a git datestamp into the context as gitstamp, to make it available for template use in HTML versions of your Sphinx documentation.
Installing
Directly install via pip by using:
pip install sphinx-gitstamp
Add sphinx_gitstamp to the extensions array in your Sphinx conf.py. For example:
extensions = ['sphinx_gitstamp']
Set the value of gitstamp_fmt in conf.py to the desired date format. For example:
# Date format for git timestamps gitstamp_fmt = "%b %d %Y"
Add gitstamp to the template, for example:
{%- if gitstamp %} Last updated on {{ gitstamp }} {%- endif %}
See Who Is Using It
You can use GitHub search or libraries.io to see who is using sphinx-sitemap.
Contributing
Pull Requests welcome! See CONTRIBUTING for instructions on how best to contribute.
Maintaining PyPI Version
These are the steps, to be run by the maintainer, for making a new Python package release.
Rev versions in sphinx_gitstamp/version.py and setup.py.
Update CHANGELOG.md
Create a tag and push to GitHub:
git tag -a vX.Y.Z -m "Release vX.Y.Z" git push --tags origin master
Create latest distribution locally:
python setup.py sdist
Upload to the test pypi.org repository:
twine upload --repository-url https://test.pypi.org/legacy/ dist/*
Upload to the production pypi.org repository:
twine upload dist/*
License
sphinx-gitstamp is made available under a BSD license; see LICENSE for details.
Originally based on the gitstamp generator in the cyrus-imapd project. This product includes software developed by Computing Services at Carnegie Mellon University (http://www.cmu.edu/computing/).
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.