该问题通常出现在使用autodoc
文档生成器时,使用递归autosummary指令自动生成模块文档,并且包含了其他模块。
这个问题的解决方法是在配置文件中添加以下参数:
autosummary_generate = True
autoclasstoc_docstring = True
在这个解决方法中,我们通过指定autosummary_generate
参数来启用递归的autosummary
。此外,我们还指定了autoclasstoc_docstring
参数,以将类的文档字符串嵌入类的Toc中,以便更好地组织文档。
下面是该解决方法的示例代码:
# conf.py
...
autosummary_generate = True
autoclasstoc_docstring = True
...