sphinxcontrib-vcs

sphinxcontrib-vcs 提供在版本控制系统中显示提交历史的功能。

设置

$ pip install sphinxcontrib-vcs

使用方法

在conf.py中将 'sphinxcontrib.vcs' 添加为扩展。

$ vi conf.py
extensions = ['sphinxcontrib.vcs']

然后，可以使用以下仓库指令。

Git

.. git::
    :number_of_revisions: 20
    :with_ref_url:
    :include_diff:

更多信息请参阅 文档 。

致谢

sphinxcontrib-vcs 受 sphinx-git 启发。

变更日志

0.3.0 (2020-04-19)

• 删除Python 3.5支持
• 添加类型注解和模块引用

0.2.2 (2019-11-06)

• 修复打包问题：无法导入sphinxcontrib.repository

0.2.1 (2019-08-04)

• 修复由于amedama41而导致的错误的Docutils DTD list_item节点

0.2.0 (2018-11-17)

• 删除Python 2.7支持和mercurial功能
• 支持内部git仓库，如GitHub Enterprise

0.1.0 (2016-09-06)

• 首次发布