Skip to main content

Sphinx extension to show commit history in version control system

Project description

Build Status

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


Release history Release notifications

This version
History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxcontrib_vcs-0.1.0-py2.py3-none-any.whl (10.7 kB) Copy SHA256 hash SHA256 Wheel 2.7 Sep 6, 2016
sphinxcontrib-vcs-0.1.0.tar.gz (12.2 kB) Copy SHA256 hash SHA256 Source None Sep 6, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page