Skip to main content
 首页 » 编程设计

python之sphinx-apidoc 与自动摘要

2024年12月31日9cloudgamer

我在尝试找出为 Django 项目实现自动文档生成的最佳方法时遇到了一些困难

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

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

我想为包根目录下的所有内容自动生成文档 - 最初开始使用 sphinx-apidoc,但后来读到一些暗示我应该改用自动摘要但一直无法查找任何概述这两个选项之间区别的信息。

请您参考如下方法:

对于其他努力解决这个问题的人来说,这是我终于找到的帮助我消除困惑的指南:

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

简而言之,使用自动摘要