我想通过sphinx为自定义python模块化/软件包系统生成(HTML)文档。 最简单的方法是什么?
我们有一个自定义的模块化系统,其中-而不是__init__.py
和模块文件直接在其旁边-我们具有以下结构:
package_one/
__mypackage__.py
_sources/
some_file.py
helpers.py
sub_package/
__mypackage__.py
_sources/
specialization.py
package_two/
__mypackage__.py
_sources/
another_file.py
所有(python3)源文件都带有epytext文档字符串,并且可能是交叉引用的(package_two可能取决于package_one)。
我将如何生成具有类似索引的文档
package_one
package_two
带有子文档
package_one/
package_one.some_file
package_one.helpers
package_one.sub_package/
package_one.sub_package.specialization
package_two/
package_two.another_file
我能想到的解决方案
index.rst
中package_one.rst
,package_one.some_file.rst
,package_two.rst
等)package_one
的父目录上运行sphinx