文档字符串未填充 Sphinx 文档

Question

我正在尝试为我的 Python 应用程序生成 Sphinx 文档。 最初我有一个复杂的结构如下......

venv
docs
├───source
├───├───_static
├───├───_templates
├───├───conf.py
├───├───index.rst
├───├───modules.rst
├───├───...
├───build
├───make.bat
├───Makefile
├───MyCode
├───├───Utilities
│   │   └───class1.py
├───├───Configurations
│   │   ├───Archive
│   │   ├───API1_Configurations
│   │   │   ├───Config1.ini
│   │   ├───API2_Configurations
│   │   │   ├───Config2.ini
│   │   ├───API3_Configurations
│   │   │   ├───Config3.ini
│   │   ├───API4_Configurations
│   │   │   ├───Config4.ini
├───├───APIs
│   │   ├───API1
│   │   │   ├───Class1.py
│   │   │   ├───Class2.py
│   │   ├───API2
│   │   │   ├───Class1.py
│   │   │   ├───Class2.py
│   │   │   ├───Supporting
│   │   │   │   └───Class1.py
│   │   ├───API3
│   │   │   ├───Support
│   │   │   │   ├───SupportPackage1
│   │   │   │   ├───Support Package2
│   │   │   │   │   └───Class1.py
│   │   │   │   └───__pycache__
│   │   │   └───Class1.py

在这种情况下，我的源代码存在于 ./docs/MyCode 中。

我在用...

• 蟒蛇 3.8
• Sphinx 4.2（虽然我尝试过很多版本）
• NumPy 文档字符串

我有...

• 添加了以下扩展
  • sphinx.ext.autodoc
  • sphinx.ext.apidoc
  • sphinx.ext.napoleon
• 尖conf.py我的代码同时使用相对路径和绝对路径（相对路径之中../MyCode ）。

出于某种原因，我最接近实际使用我的文档填充 HTML 页面的方法就是将类放在索引toctree 。 它们链接到没有我的 Python 文档字符串的空白 html 页面。

有谁知道为什么它不会抓取我的文档字符串？

Answer 1

好吧……对此感觉很愚蠢，但这只是警告的原因。

Sphinx 要求该包是一个完全可安装的包，因为当它被放置在 sphinx 包中时，它应该能够编译。 我的导入语句中有一些绝对引用，这导致我的程序失败。 因此，当类的名称仍然显示在我的 sphinx html 中时，无法拉出我程序中的实际文档字符串。