RST中的增量链接

时间:2019-06-14 12:36:08

标签: hyperlink restructuredtext

我有一个.rst文件,用于保存项目的更改: https://raw.githubusercontent.com/giampaolo/psutil/master/HISTORY.rst

我将每个问题编号标记为number_(例如1512_),然后在页面底部将超链接添加为:

.. _1512: https://github.com/giampaolo/psutil/issues/

这是无法维护的(文件太大,发行数量成指数增长)。有没有一种方法可以使它自动化,从而避免重复?

1 个答案:

答案 0 :(得分:0)

听起来您想要的是自定义的restructuredText“解释后的文本角色”。我之所以这样说,并不是因为我希望您知道这是什么,而是要提供一些关键词来搜索,如果此答案不能完全达到目标。

如果您正在使用Sphinx,则可能只需使用随附的extlinks extension

另一种选择可能是使用issuetracker extension

这两种方法都应允许您编写类似内容(使用上面引用的文件中的示例):

- :issue:`1529`: [AIX] compilation error on AIX 7.2 due to 32 vs 64 bit differences.
  (patch by Arnon Yaari)

如果这对您的用例不起作用,您还可以编写自己的角色。本质上,这意味着编写您自己的Python函数并将其注册到docutils中以生成所需的输出。有一些有关如何创建自己的角色here

的文档

您也许还可以修改其他类似的扩展名,例如traclinks扩展名(herehere)。