Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

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
Release History

Release History

This version
History Node

0.1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinxcontrib_vcs-0.1.0-py2.py3-none-any.whl (10.7 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Sep 6, 2016
sphinxcontrib-vcs-0.1.0.tar.gz (12.2 kB) Copy SHA256 Checksum SHA256 Source Sep 6, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting