Sphinx - 生成对 Trac 票证和变更集的自动引用

Question

是Sphinx，有没有办法自动链接文本，如#112或r1023 到 Trac 中相应的票证/变更集？

例如：

#112  -> http://mytracsite/tickets/112
r1023 -> http://mytracsite/changeset/1023

请参阅 TracLinks 了解更多示例。

Answer 1

如果将其放入 config.py 中

trac_url = 'http://mytratsite/'

from docutils import nodes, utils
from docutils.parsers.rst import roles
import urllib

def trac_role(role, rawtext, text, lineno, inliner, options={}, content=[]):
  ref = trac_url + '/intertrac/' + urllib.quote(text, safe='')
  node = nodes.reference(rawtext, utils.unescape(text), refuri=ref, **options)
  return [node],[]

roles.register_canonical_role('trac', trac_role)

，则可以在文档中使用 :trac:`#123` 和 :trac:`r1023` 。

这可能是快速链接到 trac 站点的最简单方法。它自动适用于所有类型的 TracLink，因为它对链接使用 intertrac 机制。

Answer 2

Sphinx 1.0 现在支持使用 extlinks 扩展的外部链接 。使用可配置的角色名称（例如“问题”），您可以编写如下链接：

:issue:`123`

它将转换为 http://mytracsite/123。