git Changelog for Sphinx
Project description
This allows you to include a git changelog of your Sphinx documentation
within the documentation.
To use it, add 'sphinx_git' to 'extensions' in your Sphinx conf.py, and add:
.. git_changelog::
where you want the list of commits to appear. This will display 10 commits by
default; if you want a different number then pass in the revisions option:
.. git_changelog::
:revisions: 5
within the documentation.
To use it, add 'sphinx_git' to 'extensions' in your Sphinx conf.py, and add:
.. git_changelog::
where you want the list of commits to appear. This will display 10 commits by
default; if you want a different number then pass in the revisions option:
.. git_changelog::
:revisions: 5
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
sphinx-git-3.tar.gz
(13.9 kB
view details)
File details
Details for the file sphinx-git-3.tar.gz
.
File metadata
- Download URL: sphinx-git-3.tar.gz
- Upload date:
- Size: 13.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 94469bac0a844456fb6dff9d5a8d15c6af7249823806cd4182145d3900ae638c |
|
MD5 | 783ef73a73d120acb1352d1e1e207c63 |
|
BLAKE2b-256 | 2d6b8f15d1221006fa663982e7a37b7c30f1089b208860e5356e00e86548ccc0 |