将项目中的所有应用程序自动记录到Sphinx
django-sphinx-autodoc的Python项目详细描述
django非常好，这样您就可以在 项目。这意味着对于大型项目，您将得到一长串应用程序 在你的设置中。安装了应用程序。
如果你在斯芬克斯中使用django，并且想在眨眼间自动记录所有这些应用程序 一只眼睛，那么这个应用程序是给你的。
- 记录项目的一个好组合是：
- sphinx
- django sphinx autodoc从应用程序生成文档
- django sphinx doc将sphinx文档集成到您的网站中
工作原理
复制项目目录中的generate_autodoc.py文件，然后执行它。
它将删除每个应用程序中按安装的应用程序列出的所有.py文件， 然后在ds_root/modules.rst中添加自动模块。
然后您将看到您的应用程序分为两个不同的类别：
- 内部应用程序是位于项目目录中的应用程序
- external application是一个位于pythonpath中的应用程序 （最好在您的虚拟机中）
良好实践
在应用程序的初始化文件中添加docstring来描述它。 Django Sphinx Autodoc将自动为您刮除。
设置
您可以修改django sphinx autodoc使用的一些设置：
- ds\u根：文档的根路径（默认为project\u dir/doc）
- ds_master_doc：主文档的名称（默认为“index.rst”）
- ds_filename：模块的名称（默认为“auto_modules.rst”）
- ds排除的应用程序：要排除的应用程序列表（默认为[]）
- ds\u excluded\u模块：要排除的文件列表（默认为[“uu init\uuuu.py”]）
待办事项
- 编写测试
- 改进不相关的内容以自动排除没有类或定义的文件
- 更新autodoc的django命令扩展名
欢迎加入QQ群-->： 979659372
