Sphinx Gitstamp Generator Extension
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/).
1 maintainer
Metadata
1 maintainer
Release files for sphinx-gitstamp 0.4.0
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-gitstamp-0.4.0.tar.gz | 5.6 kB | Without provenance | Details for sphinx-gitstamp-0.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_gitstamp-0.4.0-py3-none-any.whl | Python 3 | none | any | Details for sphinx_gitstamp-0.4.0-py3-none-any.whl |
Total release size: 11.7 kB
Release files / sphinx-gitstamp-0.4.0.tar.gz
| Download URL | sphinx-gitstamp-0.4.0.tar.gz |
|---|---|
| Size | 5.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ef88b78cba7a1507455f47bbbfc2f073529b3bb2029eef974dbd5357ff9afc49
|
|
BLAKE2b-256 checksum How to use checksums |
35bc286392c851b0ce65163b4c4e5bb9bca3b6b33198f990ce9f3756797554a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.4.2 requests/2.26.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.10
|
Release files / sphinx_gitstamp-0.4.0-py3-none-any.whl
| Download URL | sphinx_gitstamp-0.4.0-py3-none-any.whl |
|---|---|
| Size | 6.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c0a32a0033ebeb1b65f6cd41e10a92c16ca4633dbab44e6841016369adab5160
|
|
BLAKE2b-256 checksum How to use checksums |
5c7e4af3cf990b4cd5df43d764c9474a214537cf0ec5109ec2f6c64121d4ae46
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.4.2 requests/2.26.0 setuptools/45.2.0 requests-toolbelt/0.8.0 tqdm/4.30.0 CPython/3.8.10
|
Security for sphinx-gitstamp 0.4.0
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.
