Skip to main content

git Changelog for Sphinx

Project description

This allows you to include a git changelog of your Sphinx documentation
within the documentation.

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. This will display 10 commits by
default; if you want a different number then pass in the revisions option:

.. git_changelog::
:revisions: 5

You can also use a range of commits with the rev-list option (man
git-rev-parse for details on the syntax):

.. git_changelog::
:rev-list: master..mybranch

You cannot currently apply a revisions filter to the rev-list output.

In some repositories, detailed messages (i.e. the bodies of commits) will look
better in a preformatted block (e.g. if they include code samples). You can
enable preformatted blocks using the detailed-message-pre option:

.. git_changelog:: :detailed-message-pre: True

The detailed-message-pre option can be combined with all other options.

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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for sphinx-git-7.tar.gz
Algorithm Hash digest
SHA256 640fa97d519c79cc4123e9e226f9c5475b45ad5d1ae7b10efb05ab10dd719c84
MD5 403e3fd62ffbdecfeaa52083ed3b0702
BLAKE2b-256 ee472886d6af78fdae8f4f630c14f4a47d9afe3a523274ec2837203cf8929cee

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