読者です 読者をやめる 読者になる 読者になる

secretbase.log

コードはすべてNYSLです

sphinx で Git の ChangeLog を埋め込む方法 (sphinx-git)

Sphinx

sphinx-git が便利らしい

そもそも sphinx-git ってなんだろう。ちょっと試してみた。

結論

  • こんな感じで表示された

f:id:cointoss1973:20120923003027p:plain

インストール

$ pip install sphinx-git

pip コマンドで依存関係のあるパッケージも入ります。

依存パッケージ

sphinx はもちろん、GitPython (Pythonで Gitリポジトリを扱うライブラリ)を使っています。

設定

  • conf.py の extensions に設定してください。

extensions = ['sphinx_git']

Changelog
============
.. git_changelog::