Skip to main content

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.3.0 (2020-04-19)

  • drop Python 3.5 support
  • add type annotation and modules reference

0.2.2 (2019-11-06)

  • fix packaging issue: cannot import sphinxcontrib.repository

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

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.3.0.tar.gz (13.0 kB view details)

Uploaded Source

File details

Details for the file sphinxcontrib-vcs-0.3.0.tar.gz.

File metadata

  • Download URL: sphinxcontrib-vcs-0.3.0.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.1

File hashes

Hashes for sphinxcontrib-vcs-0.3.0.tar.gz
Algorithm Hash digest
SHA256 e38b1d568176f60b2af780d6b5da23785d7db16480d921bbdd6a25708d5de8dc
MD5 1ad33cba9019b3cfe9e261979ae95027
BLAKE2b-256 fe0ffae668c725472f2920b0234f1c8f08d849fdddbfe5c3e8e1415e2a3159c3

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.3.0 This release

1 file

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page