Sphinx apidoc不够自动化

时间:2019-03-03 04:59:53

标签: python-sphinx

我在一个大型仓库中工作,其中有约100个单独的文件夹,每个文件夹有20-30个子文件夹,每个子文件夹包含自己的.py文件夹。当前,我必须使用sphinx-apidoc命令为每个文件创建.rst文件,然后将路径添加到conf.py文件,然后将.rst文件添加到index.rst文件。无论如何,是否有自动化的方法,所以仅需几个命令即可完成所有这些操作。

1 个答案:

答案 0 :(得分:0)

sphinx-autodoc扩展名表示它将记录Python软件包。 Python packages依次要求将它们的文件(模块)包含在目录中,并且每个目录都包含一个名称为__init__.py的文件。

正确设置文件和目录后,Sphinx可以导入它们并按预期运行sphinx-autodoc