Sphinx autosummary“toctree包含对不存在的文档的引用”警告

时间:2016-09-02 06:38:26

标签: python python-sphinx numpydoc

我遇到了与此thread相同的问题。当我使用<div class="page_layout"> <div class="page_container"> <div class="contacts_box"> CONTACTS BOX </div> <div class="message_box"> <div class="message_displayBox"> Message Box </div> <div class="message_textBox"> </div> </div> </div> </div>构建我的Sphinx文档时,我会收到很多像这样的警告

make html

我正在使用None:None: WARNING: toctree contains reference to nonexisting document u'cars.Car.time_elapsed' 。如果我将其更改为html_theme = 'sphinx_rtd_theme',那么我就不会收到警告。如果我将classic添加到numpydoc_show_class_members = False,那么我也不会得到它们。

BUT;我非常喜欢conf.py,当我使用sphinx_rtd_theme或添加classic时,我的Python方法的' TOC '将被移除(请参阅此处的红色框) image)我宁愿留下来。

numpydoc_show_class_members = False模块的文档由

生成
cars

该模块包含一个具有两种方法的类.. automodule:: cars :members: 。文档字符串是用Car编写的。

1 个答案:

答案 0 :(得分:1)

在我看来,您目前正在使用numpydoc扩展程序。请注意,内置sphinx.ext.napoleon扩展程序现在支持Numpy和Google风格的文档字符串。

删除numpydoc扩展程序并使用sphinx.ext.napoleon可能会解决您的问题。

来源