Sphinx apidocs不包括toctree

时间:2018-03-27 23:08:50

标签: python python-3.x python-sphinx sphinx-apidoc

我的应用程序具有与此类似的结构。

Enigma
  +docs
  -enigma
     -commands
        __init__.py
        start.py
     -core
        __init__.py
        +database
         [...] # Some more python files
   +plugins

您可以在Github

上查看整个源代码树

问题

出于某种原因,每当我从make html文件夹docs/时,它都会抛出以下错误。

checking consistency... /home/meredith/PycharmProjects/Enigma/docs/api/enigma.core.rst: WARNING: document isn't included in any toctree

这很不寻常,因为该程序包会自动包含在api/modules.rst文件中,但不会显示在enigma.rst的子包部分中。

需要注意的事项可能是相关的:

  • 我在apidocs上使用--implicit-namespaces标志。可以找到完整的Makefile here
  • 核心软件包经常使用importlib。

问题

  • 为什么会这样?
  • 如果不能立即明白原因是什么,我该如何解决这个问题呢?

0 个答案:

没有答案