sphinx-apidoc

一、使用

sphinx-apidoc [OPTIONS] -o <OUTPUT_PATH> <MODULE_PATH> [EXCLUDE_PATTERN, …]

sphinx-apidoc是一个自动生成Sphinx源的工具，使用该autodoc扩展。
MODULE_PATH：是 python 的源码的文件目录。
OUTPUT_PATH：是包含 conf.py 和 *.rst 的 source 目录。
注意在 python 源码的 py 文件中，应该使用 if __name__ == '__main__' 的方式来保护程序。

二、选项

-o <OUTPUT_PATH>：放置输出文件的目录。如果它不存在，则创建它。
-f, --force：强制覆盖任何现有生成的文件。
-l, --follow-links：遵循符号链接。
-n, --dry-run：不要创建任何文件。
-s <suffix>：生成源文件的后缀。默认为rst。
-d <MAXDEPTH>：生成的目录文件的最大深度。
-T, --no-toc：不要创建目录文件。--full提供时忽略。
-F, --full：生成一个完整的Sphinx项目。
-e, --separate：将每个模块的文档放在自己的页面上。
-E, --no-headings：不要为模块/包创建标题。例如，当文档字符串已包含标题时，这很有用。
-P, --private：包括“_private”模块。
--implicit-namespaces：默认情况下，sphinx-apidoc只处理sys.path搜索模块。隐式名称空间允许模块路径搜索。
-M, --module-first：在子模块文档之前放置模块文档。
--full指定时使用这些选项：
-a：将module_path附加到sys.path。
-H <project>：设置项目名称以放入生成的文件中。
-A <author>：设置要放入生成文件的作者姓名。
-V <version>：设置项目版本以放入生成的文件中。
-R <release>：设置项目发布以放入生成的文件。

三、automodapi

https://sphinx-automodapi.readthedocs.io/en/latest/automodapi.html#module-sphinx_automodapi.automodapi

.. automodapi:: mypackage.mymodule
   <options go here>

安装

pip install sphinx-automodapi