Sphinx SCM接口
sphinxcontrib-scm的Python项目详细描述
这个包提供了sphinxcontrib.scm,一个简单的基于Sphinx的SCM接口 文档。在
安装
- pip install sphinxcontrib-scm
配置
将'sphinxcontrib.scm'添加到conf.py中的extensions列表中。在
extensions = [ 'sphinxcontrib.scm' ]
在在conf.py
^{pr2}$ 在
使用
指令
.. scm-sectionauthor:: :email: [true|false] :limit_contributors: [<int>] :min_commits: [<int>] :sort: [name|num] :type: [author|committer]
用SCM贡献者列表填充sectionauthor指令。所有选项都是 可选,并重写conf.py中的配置设置。在
角色
:scm-contribs:`.`
可以内联使用(例如作为sectionauthor指令的内容。Currenlty,电子邮件 地址不会转换为mailto链接。在
- 项目
标签: