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, 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

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinx-git, version 3
Filename, size File type Python version Upload date Hashes
Filename, size sphinx-git-3.tar.gz (13.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page