【问题标题】:Substitute a reference to a method替换对方法的引用
【发布时间】:2020-07-01 14:42:51
【问题描述】:

我想用这样的一些方法制作一个表格。

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

但是,对于我的真实姓名,表格会变得很长,尤其是当我想用 :meth:'name <fully.qualified.name> 缩短完全限定名称时。我想通过使用替换来缩短表定义,但我还没有找到让它工作的方法。注意我正在替换反引号以避免在帖子早期结束代码块。我的代码中确实有它们。以下是一些尝试。

  • .. |m| :meth:'m' 使用 |m|:未定义替换 'm' 引用
  • .. _m: :meth:'m' 使用 |m|_:未定义替换 'm' 引用
  • .. |m| replace:: :meth:'m' 使用 |m|:生成正确的文本,但没有链接

如何实现缩短参考?还是不可能?

【问题讨论】:

    标签: python python-sphinx substitution cross-reference


    【解决方案1】:

    使用replace:: 确实是答案。但是,就我而言,Sphinx 缓存了一些阻止生成链接的信息。删除整个构建文件夹后,链接就可以正常工作了。

    .. |m| replace:: :meth:`m`
    
    This is |m|.
    

    【讨论】:

    • make clean 也会删除构建文件夹,或者只删除一个构建文件以重新构建它以加快构建速度。
    猜你喜欢
    • 2023-03-09
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2010-10-25
    • 2013-10-25
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多