我想为我的代码创建一个 Sphinx 文档,但它不会正确导入所有文件
结构如下所示:
├───config
├───docs
│ ├───build
│ └───source
│ └───conf.py
└───src
├───stages
│ ├───stage1
│ │ └───stage1.py
│ ├───stage2
│ │ └───stage2.py
│ └───stage3
│ │ └───stage3.py
├───utils
│ ├───helper.py
│ └───functions.py
└───main.py
在conf.py中我添加了路径:
import os
import sys
sys.path.insert(0, os.path.abspath('.'))
sys.path.append(os.path.join(os.path.dirname(__file__),'..', '..','src'))
如果我现在运行
sphinx-apidoc
它只会创建 main.rst 文件,而不会创建其他文件。
D:\project\docs>sphinx-apidoc -f -o ./ ../src --ext-autodoc
Creating file ./main.rst.
Creating file ./modules.rst.
有人知道我做错了什么以及为什么它不会为项目中的所有 python 文件生成第一个文件吗?