Content-Length: 284475 | pFad | http://github.com/OddBloke/sphinx-git

9A GitHub - OddBloke/sphinx-git: git Changelog for Sphinx
Skip to content

OddBloke/sphinx-git

Repository files navigation

sphinx-git

https://images.weserv.nl/?url=https%3A%2F%2Ftravis-ci.org%2FOddBloke%2Fsphinx-git.png&q=12&output=webp&max-age=110?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.

Example

You can see a live example in the Read the Docs documentation; the HTML output looks like this:

https://images.weserv.nl/?url=https%3A%2F%2Fuser-images.githubusercontent.com%2F62736%2F34072980-a8469baa-e25e-11e7-968f-553caad65e56.png&q=12&output=webp&max-age=110









ApplySandwichStrip

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier!      Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

Fetched URL: http://github.com/OddBloke/sphinx-git

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy