Skip to content

Latest commit

 

History

History
26 lines (16 loc) · 968 Bytes

README.rst

File metadata and controls

26 lines (16 loc) · 968 Bytes
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.

Runbook

python setup.py sdist

Place the sdist at a public dropbox location and in utils/requirements.txt