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

  • Add a demo picture to README by Daniel Watkins at 2017-12-16 17:45:35

    This fixes #38.

  • Prepare for development of next release by Daniel Watkins at 2017-12-16 17:37:13
  • Prepare v10.1.1 release by Daniel Watkins at 2017-12-16 17:35:13
  • Make CHANGELOG formatting consistent by Daniel Watkins at 2017-12-16 17:34:10
  • Update CHANGELOG by Daniel Watkins at 2017-12-16 17:32:52
  • Merge pull request #47 from OddBloke/fix_rtd by Daniel Watkins at 2017-12-16 17:31:05

    Handle detached HEADs

  • Fix operating on a detached HEAD by Daniel Watkins at 2017-12-16 17:27:27

    This (a) should work, and (b) is the environment that ReadTheDocs builds in, so we need this to get updated docs.

  • Inline unnecessary method by Daniel Watkins at 2017-12-16 17:27:04
  • Prepare for development in next release by Daniel Watkins at 2017-12-16 17:12:28
  • Finalise v10.1.0 by Daniel Watkins at 2017-12-16 17:06:33