python - 自动摘要 “toctree contains reference to nonexisting document” 警告

Question

我面临与此 thread 中相同的问题.当我使用 make html 构建我的 Sphinx 文档时，我收到了很多这样的警告

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 时，然后是我的“TOC” Python 方法已被删除，我更喜欢保留(参见图中的红色框)。

cars 模块的文档由

.. automodule:: cars
   :members:

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

Answer 1

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

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

---

来源

• Napoleon - Marching toward legible docstrings
• Sphinx Doc - Support for NumPy and Google style docstrings