Skip to content

nanuxbe/sphinx-git

 
 

Repository files navigation

image

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.

About

git Changelog for Sphinx

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%