Sphinx extension to show commit history in version control system
Project description
sphinxcontrib-vcs
sphinxcontrib-vcs provides showing commit history in version control system.
Setup
$ pip install sphinxcontrib-vcs
Usage
Add 'sphinxcontrib.vcs' as extensions into conf.py.
$ vi conf.py
extensions = ['sphinxcontrib.vcs']
Then, repository directives are available as follows.
Git
.. git::
:number_of_revisions: 20
:with_ref_url:
:include_diff:
For more information have a look at the documentation.
Acknowledgments
sphinxcontrib-vcs is inspired from the sphinx-git.
ChangeLog
0.2.1 (2019-08-04)
- fix wrong Docutils DTD list_item node thanks to amedama41
0.2.0 (2018-11-17)
- drop Python 2.7 support and mercurial feature
- support internal git repository such as GitHub Enterprise
0.1.0 (2016-09-06)
- first release
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
Built Distribution
Close
Hashes for sphinxcontrib_vcs-0.2.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 576cbe475d39d34fde52b1ef512067e62a635dcded01932ef863953e1c38fb95 |
|
MD5 | e300b75d96e70ee2677fabfc2101757e |
|
BLAKE2b-256 | cbac3cc9095d8bc91e488288a9531c9fff6dda3e6864f41eb70bac6a45ef1184 |