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

  • Finalise CHANGELOG for v8. by Daniel Watkins at 2013-11-27 03:41:23
  • Add Read the Docs documentation to index. by Daniel Watkins at 2013-11-26 11:52:59
  • Add documentation on how to configure on Read the Docs. by Daniel Watkins at 2013-11-26 11:51:47
  • Reword README intro and add to index.rst. by Daniel Watkins at 2013-11-26 10:28:40
  • Replace most of the README with a link to RtD. by Daniel Watkins at 2013-11-26 10:03:25
  • Update PR checklist now that examples.rst is gone. by Daniel Watkins at 2013-11-26 09:59:05
  • Add Using section, superseding examples.rst. by Daniel Watkins at 2013-11-26 09:57:56
  • Mention move to package in CHANGELOG. by Daniel Watkins at 2013-11-26 07:21:00
  • Output detailed commit messages as paragraphs rather than captions to fix PDF output. by Daniel Watkins at 2013-11-26 07:06:59
  • Update .gitignore. by Daniel Watkins at 2013-11-26 06:58:54
Read the Docs v: v8
Versions
v8
latest
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.