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

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

Uploaded Source

File details

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

File metadata

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

File hashes

Hashes for sphinx-git-4.tar.gz
Algorithm Hash digest
SHA256 e065684cdf36025c65040d19d8f60f2c315f4771742e61abe24acf92d61c1224
MD5 ba28264cae5fed7d5e0a246d893522ec
BLAKE2b-256 81d527495660ec65df0d4808ac2c19db89d7bbde54c8bc4b0be5dd1c667804fd

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