我有以下Sphinx目录结构:
top-directory
|
|--docs
| |
| |-conf.py
| |-index.rst
|
|
|--first-dir
|
|- __init__.py
|- script1.py
|- script2.py
|
|--second-dir
|
|- __init__.py
|- script3.py
|- script4.py
在conf.py中,我添加了以下代码:
sys.path.insert(0,os.path.abspath('.'))
sys.path.insert(0,os.path.abspath('../first-dir'))
sys.path.insert(0,os.path.abspath('../second-dir'))
运行后
sphinx-apidoc -f -e -o . ../
Sphinx生成一堆名为first-dir.script1.rst,first-dir.script2.rst的.rst文件,依此类推。每个.rst文件的内容遵循以下模式:
.. automodule:: first-dir.script1
:members:
:undoc-members:
:show-inheritance:
我将first-dir.script1添加到index.rst,但是在doc目录中运行make html后,我只得到空页。但是,当我将first-dir.script1.rst的内容更改为:
.. automodule:: script1
:members:
:undoc-members:
:show-inheritance:
一切正常,第一dir.script1填充了script1中的模块。我假设我做错了,因为Sphinx的重点是自动生成.rst文件,但我不确定我做错了什么。