Sphinx SCM接口

sphinxcontrib-scm的Python项目详细描述


[Latest PyPI version][Supported Python versions][pre-commit: enabled][Code style: black][Code style: prettier]

这个包提供了sphinxcontrib.scm,一个简单的基于Sphinx的SCM接口 文档。在

安装

  1. pip install sphinxcontrib-scm

配置

  1. 'sphinxcontrib.scm'添加到conf.py中的extensions列表中。在

    extensions = [ 'sphinxcontrib.scm' ]
    
  2. 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链接。在

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java如何拆分字符串(基于各种分隔符),但不保留空格?   解析。Json格式的txt文件和knime中的java   java Spring rest api为什么在rest api调用的响应中更改了数据类型   升华文本3抛出java。lang.ClassNotFoundException,而记事本++不存在   java Android指纹扫描仪在尝试5次后停止工作?   java Android如何设置精确的重复报警?   java如何使用HTTPGET connect为access API输入用户名和密码   java当测试报告显示没有测试失败时,Gradle为什么说“有失败的测试”?   用Gson实现java获取响应   MapReduce程序中函数错误的java不可映射参数   java spring安全性不符合自动代理的条件   java GWT使用异步回调进行同步/阻塞调用   java奇怪的类数组问题无法在jsp中显示   如何在java中使用PrinterJob使用epl打印条形码   java如何在JTable中居中单元格   将Java Mockito测试转换为Kotlin   html Java正则表达式模式匹配到多个相同标记   testCompile中缺少java Gradle(Android)多项目依赖项   在输入提示后输入字符串时发生java FileNotFoundException