sphinx-git 0,0 travis-ci python

git Changelog for Sphinx

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

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_.

.. _Sphinx documentation tool: http://sphinx-doc.org/ .. _the documentation on Read the Docs: http://sphinx-git.readthedocs.org/en/latest/?utm_source=github&utm_medium=github&utm_campaign=github

Related Repositories

sphinx-git

sphinx-git

git Changelog for Sphinx ...

django-projects

django-projects

django-projects is a Django web application for displaying documentation of a git project via sphinx. This works very much like djangoproject.com, but it is designed for multiple projects. See an example at: http://kylefuller.co.uk/projects/ ...

aaarrghh

aaarrghh

Project / Task management with Sphinx and Git ...

git-sql-sphinx

git-sql-sphinx

Index git log entries using Sphinx ...

cmusphinx-1

cmusphinx-1

A git clone of the CMU Sphinx svn repository ...


Top Contributors

OddBloke pomalley nanuxbe gelendir msabramo maurodec

Releases

-   v10.0.0 zip tar
-   v9 zip tar
-   v8 zip tar
-   v7 zip tar
-   v6 zip tar
-   v5 zip tar
-   v4 zip tar
-   v3 zip tar
-   v2 zip tar
-   v1 zip tar