An extension for the Sphinx. That excerpt changelog with lowdown arrangement (https://pypi.python.org/pypi/Lowdown/0.1.1) from specified repository's git commit log.
pip install -e git+https://github.com/yamahigashi/sphinx-git-lowdown.git#egg=sphinx_git_lowdown
Add sphinx_git_lowdown to the extensions list in your project's conf.py.
extensions = ['sphinx_git_lowdown']
- git_release_logs
- git_change_logs
git_release_logs
search_path:
The git-rev-list command's paths option
release_tags:
The release tag
repository:
(optional) where repository is
max_count:
(optional) maximum count of change logs. (default: 200)
.. git_release_logs::
:search_path: Characters/001/*
:release_tags: release-*
:repository: C:/repository
:max_count: 200
will be shown as
git_change_logs
search_path:
git-rev-list command's paths option
repository:
(optional) where repository is
max_count:
(optional) maximum count of change logs. (default: 200)
.. git_change_logs::
:search_path: Characters/001/*
:repository: C:/repository
:max_count: 200
will be shown as