Sphinx extension to show commit history in version control system
Project description
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:
Mercurial
.. mercurial:: :number_of_revisions: 20 :with_ref_url: :include_diff:
For more information have a look at the documentation.
Note
Mercurial supports Python 2.x only. So sphinxcontrib-vcs supports the mercurial directive on Python 2.7.
Acknowledgments
sphinxcontrib-vcs is inspired from the sphinx-git.
ChangeLog
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
sphinxcontrib-vcs-0.1.0.tar.gz
(12.2 kB
view hashes)
Built Distribution
Close
Hashes for sphinxcontrib_vcs-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d5f9e0ad2bf8542d394ae3f0d845e0ce01179f19d6ccbfa7241996327d30d71 |
|
MD5 | 9fc4cdb788a9f888a57516003732f82d |
|
BLAKE2b-256 | 8ee4ef26045df6d5a51d8a9da8cd7cb59ad9ba2aff04c4872926b5bed4a10824 |