sphinx-apidoc与autosummary

Question

我遇到了一些麻烦，试图找出为Django项目实现自动文档生成的最佳方法

我的项目结构类似于以下内容：

myproj/           # project root
|- docs/          # docs root
|- myproj/        # package root
   |- app1/
   |- app2/
   |- app3/
   utils.py
   ...

我想自动为软件包根目录下的所有内容生成文档，并且最初使用sphinx-apidoc开始阅读，但是随后读取的内容却暗示我应该使用自动摘要，而无法找到任何概述的信息这两种选择之间的区别是什么。

Answer 1

对于其他努力解决问题的人，这是我终于找到的指南，可以帮助我消除混乱：

https://romanvm.pythonanywhere.com/post/autodocumenting-your-python-code-sphinx-part-ii-6/

简而言之，请使用自动摘要