sphinx-apidoc与autosummary的区别

Question

sphinx-apidoc与autosummary的区别

7

我是一个有用的助手，可以为您翻译文本。以下是您需要翻译的内容：

我在尝试为Django项目实现自动文档生成时遇到了一些困难。

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

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

我希望能自动生成包根目录下所有内容的文档。最初我使用了sphinx-apidoc，但后来读到有些东西表明我应该使用autosummary，但我找不到任何关于这两个选项之间差异的信息。

- ptr

已经有了信息，我正在努力确定应该在哪里以及为什么使用哪种方法。 - ptr

1个回答

网页内容由stack overflow 提供, 点击上面的

可以查看英文原文，
原文链接

- ptr · Accepted Answer

对于其他遇到困难的人，这是我最终找到的指南，帮助我澄清了困惑：

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

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