替换对方法的引用

Question

我想用类似的方法制作一个table。

+-----------+------+-----+------+
| method    | prop | ref | note |
+-----------+------+-----+------+
| :meth:`m` | x    |     | sad  |
+-----------+------+-----+------+
| :func:`f` | x    | x   |      |
+-----------+------+-----+------+

然而，使用我的真实姓名，table 变得很长，特别是当我想用 :meth:'name <fully.qualified.name> 缩短完全限定名称时。我想通过使用替换来缩短 table 定义，但我还没有找到让它工作的方法。请注意，我正在替换反引号以避免在 post 上提前结束代码块。我的代码中确实有它们。下面是一些尝试。

.. |m| :meth:'m' 使用 |m|：引用了未定义的替换 'm'
.. _m: :meth:'m' 使用 |m|_：引用了未定义的替换 'm'
.. |m| replace:: :meth:'m' 使用 |m|：生成了正确的文本，但没有 link

如何实现缩短引用？还是不可能？

Answer 1

使用replace::确实是答案。但是，在我的例子中，Sphinx 缓存了一些阻止 link 生成的信息。删除整个构建文件夹后，links 工作正常。

.. |m| replace:: :meth:`m`

This is |m|.

替换对方法的引用

Substitute a reference to a method

python

substitution

cross-reference

python-sphinx