Python Sphinx记录包的公共接口

时间:2014-05-01 23:43:56

标签: python documentation package python-sphinx

我有一个包含子模块的Python包。目前,我的目的是允许使用包导出的功能,例如:

package_X
+-- __init__.py
+-- submodule_A.py
+-- submodule_B.py

子模块是实现细节。包的用户需要知道的所有内容都将导出到__init__.py文件中。

现在,在使用Sphinx构建文档时,我获得了TOC和文档,如下所示:

package_X

  Submodules
    submodule_A.py
    submodule_B.py

我是否可以写__init__.pysubmodule_*.py来设置或指示公开内容,就好像它直接在package_X中一样?我也准备修改conf.py以使其发挥作用。

0 个答案:

没有答案