5

我面临与此线程相同的问题。当我构建我的 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或添加时，我的 Python 方法numpydoc_show_class_members = False的“目录”会被删除，我更喜欢保留它（参见图像中的红色框）。

图片

该cars模块的文档由

.. automodule:: cars
   :members:

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

4

1 回答 1

1

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

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

来源

于 2017-04-05T17:25:07.063 回答