狮身人面像不够自动化 [英] Sphinx apidoc not automated enough

问题描述

我在一个大型的资源库中工作，其中有大约100个单独的文件夹，每个文件夹都有20-30个子文件夹，每个子文件夹都包含自己的.py文件夹。目前，我必须使用sphinx-apidoc命令为每个文件创建.rst文件，然后将路径添加到conf.py文件，然后将.rst文件添加到index.rst文件。有没有自动化的方法，这样只需几个命令就可以完成所有这些操作。

推荐答案

sphinx-autodoc扩展声明它将记录Python包。Python packages又要求它们的文件(模块)包含在一个目录中，并且每个目录包含一个名为__init__.py的文件。

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

这篇关于狮身人面像不够自动化的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！