sphinxcontrib-issuetracker 0.11

安装

此扩展可以从Python Package Index：

pip install sphinxcontrib-issuetracker

这个扩展需要sphinx 1.1和pythonn 2.6或python 3.1。

用法

只需将此扩展添加到extensions并配置问题跟踪程序：

extensions = ['sphinxcontrib.issuetracker']

issuetracker = 'github'
issuetracker_project = 'lunaryorn/sphinxcontrib-issuetracker'

现在像#10这样的问题引用被替换为指向问题跟踪程序的链接 除非引用以文本形式出现，如inline 文字或代码块。

您可以通过设置issuetracker\u明文问题来禁用此神奇行为 到False：

issuetracker_plaintext_issues = False

现在不再替换文本引用。但是，您仍然可以显式地 issue角色的引用问题。

有关详细信息，请参阅documentation。

支架

如果有问题，请向issue tracker报告，在 此扩展或缺少对特定问题跟踪程序的支持，但请尊重 以下规则：

• 检查问题是否尚未报告。
• 检查master分支中的问题是否已修复。
• 标题清晰、语法描述详细的开放性问题 正确，完整的句子。

开发

源代码托管在Github：

git clone https://github.com/lunaryorn/sphinxcontrib-issuetracker

请分叉存储库并用您的修复程序发送拉取请求或更新 功能，但要遵守以下规则：

• 阅读how to properly contribute to open source projects on GitHub。
• 如果需要，可以使用主题分支在以后轻松地修改拉取请求。
• 写good commit messages。
• 在打开拉取请求之前挤压主题分支上的提交。
• 尊重PEP 8（使用pep8检查编码风格的符合性）
• 添加单元测试
• 打开pull request 只涉及一个主题，标题和描述清楚 语法正确，句子完整。