Welcome to sphinx-git’s documentation!

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.

See Recent Changes below for an example of what can be done with it.

Recent Changes

  • Prepare for version 10 development. by Daniel Watkins at 2015-02-23 10:24:15
  • Finalise CHANGELOG for v9. by Daniel Watkins at 2015-02-23 10:14:56
  • Merge pull request #19 from pomalley/master by Daniel Watkins at 2015-02-23 10:12:50

    Add search_parent_directories=True to Repo creation.

  • Add search_parent_directories=True to Repo creation. by Peter O’Malley at 2015-02-20 09:28:01

    Also, fix test by doing the following: * suppress pylint “Too few public methods” warning * up GitPython version to 0.3.6 Fixes #18 (error with new version of GitPython).

  • Try astroid<1.3 by Daniel Watkins at 2015-02-23 09:46:46
  • Start looking for a version of astroid that supports Python 2.6. by Daniel Watkins at 2015-02-23 09:38:21
  • Pin pylint to a version that supports Python 2.6. by Daniel Watkins at 2015-02-23 09:22:09

    For now.

  • Merge pull request #17 from maurodec/fix_commit_author_unicode by OddBloke at 2014-07-31 15:16:50

    Added support for handling Author name in Unicode.

  • Added support for handling Author name in Unicode. by Mauro de Carvalho at 2014-07-20 09:16:50
  • Fix PEP8 error. by Daniel Watkins at 2014-05-21 04:31:58