Python Django Sphinx自动模块——基础

我有一个有几个大型应用程序的项目，其中设置和应用程序文件被拆分

目录结构如下所示：

项目名称

• _初始值
• 应用程序
• _初始值
• 附件1
• 附件2
• 第三方
• _初始值
• lib1
• lib2
• 背景
• _初始值
• 已安装的_apps.py
• path.py
• templates.py
• locale.py
• url.py

每个应用程序都是这样的

• _初始值
• 管理员
• _初始值
• file1.py
• file2.py
• 模型
• _初始值
• model1.py
• model2.py
• 测验
• _初始值
• test1.py
• test2.py
• 观点
• _初始值
• view1.py
• view2.py
• url.py

如何使用Sphinx自动生成文档

我想要那样的东西 对于每个in-settings模块或已安装的_应用程序（不是从django.*或第三方。*开始），请根据docstring为我提供自动文档输出

和autogen文档，并在git提交之前运行测试

顺便说一句。 我试着用手工制作.rst文件

.. automodule:: module_name
   :members:

但是对于这么大的一个项目来说太糟糕了， 而且它对设置不起作用

有自动生成的方法吗

我不喜欢斯芬克斯，有没有更好的办法解决我的问题

看

即将发布的版本包括一个脚本

在这里可能会有帮助

从文件中：

工作原理 复制项目目录中的

generate_autodoc.py

文件，然后 执行它

它将刮除列出的每个应用程序中的所有

.py

文件

INSTALLED_APP

，然后在您的

DS_ROOT/modules.rst

中添加自动模块

然后，您将看到应用程序分为两个不同类别：

• 内部应用程序是位于项目中的应用程序 目录
• 外部应用程序是一个应用程序，它位于您的 pythonpath（最好是在您的虚拟环境中）

良好做法 在应用程序的

\uuuu init\uuuu.py

文件中添加一个docstring来描述它。 django sphinx autodoc将自动为您刮取