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

发布于 2024-08-18 19:20:27 字数 449 浏览 9 评论 0原文

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

例如：

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

请参阅 TracLinks 了解更多示例。

原文

Is Sphinx, is there way to automatically link text like #112 or r1023 to the corresponding tickets/changesets in Trac?

For eg:

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

See TracLinks for more examples.

分享到QQ

分享到微博

如果你对这篇内容有疑问，欢迎到本站社区发帖提问参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。

发布评论

需要登录才能够评论，你可以免费注册一个本站的账号。

时光磨忆 2024-08-25 19:20:27

如果将其放入 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 机制。

If you put this in your 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)

Then you can use :trac:`#123` and :trac:`r1023` in your documents.

This is probably the easiest way to make quick links to a trac site. It automatically works for all kinds of TracLinks because it uses the intertrac mechanism for the links.

回复收藏 0 原文