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
You cannot currently apply a revisions filter to the rev-list output.
In some repositories, detailed messages (i.e. the bodies of commits) will look
better in a preformatted block (e.g. if they include code samples). You can
enable preformatted blocks using the detailed-message-pre option:
.. git_changelog:: :detailed-message-pre: True
The detailed-message-pre option can be combined with all other options.
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
You cannot currently apply a revisions filter to the rev-list output.
In some repositories, detailed messages (i.e. the bodies of commits) will look
better in a preformatted block (e.g. if they include code samples). You can
enable preformatted blocks using the detailed-message-pre option:
.. git_changelog:: :detailed-message-pre: True
The detailed-message-pre option can be combined with all other options.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-git 6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx-git-6.tar.gz | 14.8 kB | Details |
Release files / sphinx-git-6.tar.gz
| Download URL | sphinx-git-6.tar.gz |
|---|---|
| Size | 14.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3203551db7e65f270ca685f80449c3ea4e58a196d96f067605cb0b733cee0755
|
|
BLAKE2b-256 checksum How to use checksums |
a2dda061246abd8a6e3e9d916ac70d6df8626883e4a8be7a9fa57f3a2537af7c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
