Skip to content
git Changelog for Sphinx
Python
Failed to load latest commit information.
docs
sphinx_git
tests Add filename_filter to changelog directive Apr 22, 2016
.gitignore
.pylintrc
.travis.yml
CHANGELOG
COPYING
MANIFEST.in Add CHANGELOG. Jul 7, 2013
README.rst
requirements.txt Remove unnecessary requirements from requirements.txt Feb 21, 2016
setup.py Use six.text_type instead of unicode Feb 21, 2016
tox.ini

README.rst

https://travis-ci.org/OddBloke/sphinx-git.png?branch=master

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.

Something went wrong with that request. Please try again.