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.

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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for sphinx-git-5.tar.gz
Algorithm Hash digest
SHA256 2830a53c55336d743a1df0d3695e47791d5470e06d0c54986c06b27ee0d7c16a
MD5 f4cde769433e314222dd42121768ad8a
BLAKE2b-256 777562c2634953c43b3286d15872149888ae36e3cd2dae504c61e762547af1cc

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