sphinx-git is an extension to the Sphinx documentation tool that allows you to include excerpts from your git history within your documentation. This could be used for release changelogs, to pick out specific examples of history in documentation, or just to surface what is happening in the project.
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.
For more details, see the documentation on Read the Docs.
1 maintainer
Metadata
1 maintainer
Release files for sphinx-git 8
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-8.tar.gz | 15.0 kB | Details |
Release files / sphinx-git-8.tar.gz
| Download URL | sphinx-git-8.tar.gz |
|---|---|
| Size | 15.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
99f29eb6406c70c87d5a29f7127bd47f5f4a4d262ec5e25e8320e9298f79eb2d
|
|
BLAKE2b-256 checksum How to use checksums |
b3098108f958da5f2be0ef2546aabfe6a625bd05842c3843f531b3c59b71d238
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
