Skip to main content

git Changelog for Sphinx

Project description

https://travis-ci.org/OddBloke/sphinx-git.png?branch=master

sphinx-git is an extension to the Sphinx documentation tool that allows you to include excerpts from your git history within your documentation. This could be used for release changelogs, to pick out specific examples of history in documentation, or just to surface what is happening in the project.

To use it, add ‘sphinx_git’ to ‘extensions’ in your Sphinx conf.py, and add:

.. git_changelog::

where you want the list of commits to appear.

For more details, see the documentation on Read the Docs.

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

sphinx-git-9.tar.gz (15.1 kB view details)

Uploaded Source

File details

Details for the file sphinx-git-9.tar.gz.

File metadata

  • Download URL: sphinx-git-9.tar.gz
  • Upload date:
  • Size: 15.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for sphinx-git-9.tar.gz
Algorithm Hash digest
SHA256 e5d120d9444307f017756014ea711b1b6682a12c2acc1d0bc259166220ac1f87
MD5 b42a394031efbd11c4246c27b9112a51
BLAKE2b-256 a17846bda5f9b9358208fe01559550f1de0d2626716c91069eb01951a39c460e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page