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/

简而言之，使用自动摘要