Autodoc Django项目为Sphinx安装的所有模块
django-giza的Python项目详细描述
注意
原始代码来自https://github.com/Aquasys/django-sphinx-autodoc 此版本已被清理并修改为用作django 管理指挥部。
django非常好，这样您就可以在 项目。这意味着对于大型项目，您将得到一长串应用程序 在你的设置中。安装了应用程序。
如果你在斯芬克斯中使用django，并且想在眨眼间自动记录所有这些应用程序 一只眼睛，那么这个应用程序是给你的
- 记录项目的一个好组合是：
- sphinx
- cartouche避免用rst语法污染docstring
- django giza从应用程序生成文档
- django sphinx doc将sphinx文档集成到您的网站中
工作原理
它将删除每个应用程序中按已安装的应用程序列出的所有.py文件， 然后在project/sphinx_root/auto_modules.rst中添加automodules。
然后您将看到您的应用程序分为两个不同的类别：
- 项目应用程序是位于项目目录中的应用程序
- 3rd party apps是位于pythonpath中某个位置的应用程序 （最好在您的虚拟机中）
良好做法
在应用程序的__init__.py文件中添加docstring来描述它。 django giza会自动为您刮下它（尽管__init.__.py 默认情况下排除文件…。
安装
$ pip install django-giza
然后将giza添加到settings.py中已安装的应用程序中
用法
$ ./manage.py giza
您还可以指定文档根目录的相对路径：
$ ./manage.py giza private/documentation
设置
可以修改django giza使用的某些设置：
- giza\u docs根目录：
文档的根路径（需要绝对路径）
- 默认为：
"PROJECT_ROOT/docs"
- giza_index_doc：
主文档的名称。
- 默认为：
"index.rst"
- giza_文件名：
生成的模块文档的名称。
- 默认为：
"auto_modules"
- giza文档标题：
模块页的标题。
- 默认为：
"Python modules"
- GIZA_内部标题：
内部应用程序部分的标题。
- 默认为：
"Project Apps"
- giza_外部标题：
外部应用程序部分的标题。
- 默认为：
"3rd Party Apps"
- GIZA不包括应用程序： 要排除的应用程序列表。可以在结尾使用通配符。
默认为： ["django.*", "giza"]
- giza排除的模块： 要排除的文件名列表。
默认为： ["__init__.py"]
- giza_automodule_选项：
automodule指令的选项列表，例如 “私有成员”（不带冒号分隔符）
- 默认为：
["deprecated", "members", "private-members","special-members","show-inheritance"]
待办事项
- 编写测试
- 改进不相关的内容以自动排除没有类或定义的文件
欢迎加入QQ群-->： 979659372
