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

Question

我遇到了与此线程相同的问题.当我构建我的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到conf.py,那么我不明白他们要么.

但; 我非常喜欢sphinx_rtd_theme,当我使用classic或添加时numpydoc_show_class_members = False,我的Python方法的' TOC '被删除(参见此图像上的红色框),我更喜欢留下.

该cars模块的文档由

.. automodule:: cars
   :members:

该模块包含一个Car具有两种方法的类.文档字符串是用来写的numpydoc.

Answer 1

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

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