我是Python和Sphinx的新手,我正在尝试autodoc位于类似于以下结构的目录中的python文件:
Project
├── Sphinx
| ├── index.rst
| ├── autodoc.rst
| └── conf.py
├── Scripts
| ├── file1.py
| └── file2.py
| ├── folder
| | └── file3.py
我的conf.py文件包含:
sys.path.insert(0, os.path.abspath("../Scripts/"))
而autodoc包含:
.. automodule:: file1
:members:
.. automodule:: file2
:members:
.. automodule:: folder.file3
:members:
File3.py没有正确自动调整(错误:没有名为metric.billpay的模块)
我也尝试过:
.. automodule:: folder/file3
:members:
但我收到了
警告:自动模块的签名无效(u'folder / file3')警告:不知道要导入哪个模块来自动记录u'folder / file3'(尝试在文档中放置“module”或“currentmodule”指令,或者给出一个明确的模块名称)
有谁知道如何解决这一问题?我是Python,Sphinx和StackOverflow的新手,所以如果这个问题有问题我很抱歉 .
1 回答
另外:
之后我添加了这个:
这允许我使用autodoc访问Folder中的文件 .