sphinx-apidoc 与自动摘要

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/

简而言之，使用自动摘要