Sphinx apidocs不包括生成的包文档

2024-05-20 08:20:54 发布

您现在位置:Python中文网/ 问答频道 /正文

我有一个应用程序,它的结构与此类似。在

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

您可以在Github上查看整个源代码树

问题

由于某些原因,每当我从docs/文件夹中执行make html操作时,它会抛出下面的错误。在

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。在

问题

  • 为什么会发生这种情况?在
  • 如果不能立即确定原因,我该如何排除故障?在

Tags: pycoreapi应用程序docsinitenigma原因