小编kes*_*mit的帖子

使用 toctree 进行自动摘要不会为方法创建文档

我正在使用带有 numpydoc 扩展和自动摘要的 sphinx。经过一些实验,我将以下选项添加到我的 conf.py 文件中。

autosummary_generate = True
numpydoc_show_class_members = False
Run Code Online (Sandbox Code Playgroud)

这为我引用的每个类提供了一个新文件,如下所示,它还创建了所有属性和方法的汇总表。

.. autosummary::
   :toctree: generated/
   :nosignatures:

   MyClass
Run Code Online (Sandbox Code Playgroud)

问题是,虽然文档字符串的第一行有一个方法的摘要表,但方法的名称没有链接到任何内容。如何获取方法的文档字符串来创建自己的文件(或者至少在与类相同的文件中生成文档)?

python python-sphinx autodoc numpydoc toctree

7
推荐指数
1
解决办法
4788
查看次数

标签 统计

autodoc ×1

numpydoc ×1

python ×1

python-sphinx ×1

toctree ×1