引用由狮身人面像中的autodoc生成的函数？

2018-06-27 00:00:40

我使用Sphinx autodoc功能根据我的Python库的文档字符串生成文档。

交叉引用的语法在这里找到

标签必须位于该部分的前面，以便可以从该文档的其他区域引用该部分。

我拥有的是我的一个类的.rst（ReStructeredText）文件。它用

.. autoclass:: classname
    :members:

为该课程生成文档。

我的问题是，我将如何从文档中的另一个.rst文档引用该类的自动生成方法？如果我尝试在方法的文档字符串中放置一个标签，Sphinx会抱怨。如果我尝试在方法标题之前放置标签，则狮身人面像不会识别它。

有没有一个简单的方法来做到这一点，或者我将不得不在我的类文件中明确写入方法名称并在它之前添加一个标签？

这里是一个例子，在[Python文档2中做了我所需要的参考（我假设它使用了autodoc功能，但我不确定）

您不需要添加标签。为了引用Python类，方法或其他记录的对象，请使用Python域提供的标记。

例如，下面定义了对mymethod方法的交叉引用：

:py:meth:`mymodule.MyClass.mymethod`

甚至更简单（因为Python域是默认的）：

:meth:`mymodule.MyClass.mymethod`

您在问题中链接到的TextWrapper.wrap文档包含两种此类交叉引用（单击“显示源”以查看reST标记）。

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