在python docstring中引用reST标签

我想在我的Python方法docstring中引用reST标签,并希望Sphinx生成适当的链接。

我尝试了以下这对我不起作用。

myown.rst

.. my-label:
   Some explanation ...

mymodule.py

def somefunc():
    """ See :ref:`my-label`. """
    ... rest of the code ...

这会在生成的html文件中生成“See my-label”作为文本,而我期待它创建适当的超链接。

我在python-docs中看到了这种引用(例如,参见https://docs.python.org/3/library/functions.html#classmethod)并引用了函数定义(这是通用解释)。 但是,这不是从docstrings生成的(从funcobject.c可以看到)..所以我倾向于认为它是手工制作的!


基于来自@mzjn的评论 - 第一个文件中缺少部分标题。 添加并重新生成修复了这个问题。

链接地址: http://www.djcxy.com/p/75499.html

上一篇: Refer reST label in python docstring

下一篇: Cant use Ref with a Label using Sphinx doc