我想从嵌套文件夹结构中的脚本生成 sphinx autodoc 文档:
└── programs
└── general_name
└── another_folder
├── script1.py
└── script2.py
由于某种原因, script1.py 和 script2.py 未与自动文档一起显示,我只能看到脚本名称:
programs.general_name.another_folder package
¶Submodules
programs.general_name.another_folder.script1 module
programs.general_name.another_folder.script2 module
完整文件夹结构:
../
├── docs
│ ├── _build
│ │ ├── doctrees
│ │ │ ├── environment.pickle
│ │ │ ├── index.doctree
│ │ │ └── rst
│ │ └── html
│ │ ├── genindex.html
│ │ ├── index.html
│ │ ├── objects.inv
│ │ ├── rst
│ │ ├── search.html
│ │ ├── searchindex.js
│ │ ├── _sources
│ │ └── _static
│ ├── conf.py
│ ├── index.rst
│ ├── make.bat
│ ├── Makefile
│ ├── rst
│ │ ├── modules.rst
│ │ ├── programs.general_name.another_folder.rst
│ │ ├── programs.general_name.rst
│ │ └── programs.rst
│ ├── _static
│ └── _templates
└── programs
└── general_name
└── another_folder
├── script1.py
└── script2.py
我正在运行这个命令:
/docs $ sphinx-apidoc -f -o rst/ ../programs/ && make html
我也尝试过:
$ sphinx-apidoc -f -o rst/ ../programs/general_name/another_folder/ && make html
但是script1模块和script2模块在生成html文件时是空的。
解决方案:
找到导致问题的原因 - 破折号“-”。
another_folder 实际上被命名为 get_requests_from_server-10
将文件夹重命名为 get_requests_from_server_10 后,自动停靠开始工作