Python 斯芬克斯自选摘要“；目录树包含对不存在文档的引用；警告

我正在尝试使用Sphinx为大型python代码库自动创建api文档

我尝试过使用build_modules.py和sphinx apidoc。无论使用哪一种，我都可以在我的输出目录中为包和顶级模块成功创建rst文档

但是，当我使用

make html

它给出了数千个此类错误：

<autosummary>:None: WARNING: toctree contains reference to nonexisting document 'rstDocs/src.Example1.class1.method1'

---

感谢您提供有关如何解决这些警告的建议！我想远离任何涉及修改sphinx站点包文件的解决方案。

对于这么晚的回答（如果可以考虑的话），我感到很抱歉，但我发现了这个链接，它讨论了可能发生在您身上的事情：

如果您的文档代码中有一些特殊的文档刮刀，在autosummary已经运行之后正在构建autosummary文档，那么如果您仍然存在此问题，那么您可能需要研究这种想法。虽然，我不确定这会有多大帮助

---

从链接中添加的关键字是：<代码> NuPyDoCuxSuffCyraseMys= Falue<代码> >代码> CONP.PY < /P> < P> >如果您使用“代码> NUPYDOC 扩展名，您可以考虑删除它，并使用<代码>狮身人面像.Ext.NAPulon < /Cord>。 从1.3版开始，Numpy和Google风格的Docstring实际上就受到这个内置扩展的支持

因此，删除

numpydoc

并在

conf.py

中使用

sphinx.ext.poleon

可能会解决您的问题

---

来源

---

我也遇到了这个问题，为此花了几个小时，以下几点对我很有用：

狮身人面像可能会很挑剔，有时会对你意想不到的事情大惊小怪。 例如，您可能会遇到以下情况：

WARNING: toctree contains reference to nonexisting document u'all-about-me'
...
checking consistency...
<your repository>/my-first-docs/docs/all-about-me.rst::
WARNING: document isn't included in any toctree'

警告：目录树包含对不存在的文档u'all-about-me'的引用
...
正在检查一致性。。。
/我的第一份文件/文件/关于我的一切。rst:：
警告：文档未包含在任何目录树的目录中

很可能，这里发生的事情是您在

中缩进了我的所有信息。。目录树：：

有四个空格，而斯芬克斯预期有三个空格

---

资料来源：

您确定有指向生成的文档的目录树条目吗？e、 g.到您在上面发布的

src

包文档？相关的未解决问题：如果您这样做，将删除方法表，但：（有人发现了不删除方法表的解决方案吗？我无法切换到

sphinx.ext.poleon

，因为它似乎不支持与

numpydoc\u use\u plots

相同的功能。

WARNING: toctree contains reference to nonexisting document u'all-about-me'
...
checking consistency...
<your repository>/my-first-docs/docs/all-about-me.rst::
WARNING: document isn't included in any toctree'