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']
To change the default time format of %b %d, %Y, set the value of gitstamp_fmt in conf.py to the desired time format. For example:
# Date format for git timestamps
gitstamp_fmt = "%Y-%m-%d %H:%M:%S %z"
Add gitstamp to the jinja template, for example:
{%- if gitstamp %} This page was last updated on {{ gitstamp }}. {%- endif %}
Contributing
Pull Requests welcome! See CONTRIBUTING for instructions on how best to contribute.
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.
Source Distribution
Built Distribution
Hashes for sphinx_gitstamp-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0a32a0033ebeb1b65f6cd41e10a92c16ca4633dbab44e6841016369adab5160 |
|
MD5 | eef7a1ce397df3815890a7e5f8dd6de0 |
|
BLAKE2b-256 | 5c7e4af3cf990b4cd5df43d764c9474a214537cf0ec5109ec2f6c64121d4ae46 |