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
You can also use a range of commits with the rev-list option (man
git-rev-parse for details on the syntax):
.. git_changelog::
:rev-list: master..mybranch
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
You can also use a range of commits with the rev-list option (man
git-rev-parse for details on the syntax):
.. git_changelog::
:rev-list: master..mybranch
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-4.tar.gz
(14.3 kB
view hashes)