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嵌套循环打印一个数字,旁边有相同数量的星号   java JodReports替代方案   java如何将模型类parcelable对象从片段传递到活动?   java JCS缓存删除功能不删除特定元素   如何打开。Java的dll文件。   java在这种情况下如何选择聚合根?   java从CellEditorListener获取编辑的TreeNode   Java到web服务和mysql   从openssl ec在Java中创建公钥时出现加密无效密钥异常   Java数组:添加多个数组的元素时忽略空数组   java在初始化后向fragment发送数据   JButtons的java数组正在返回void   若联接列不包含特定值,则java JPA条件生成器仅返回实体   java ActionBar问题:NPE   java Portlet是被广泛使用还是非常罕见?