python - Django Sphinx 自动模块——基础知识

标签 python django documentation python-sphinx sphinx-apidoc

<分区>

我有一个包含多个大型应用程序的项目,其中设置和应用程序文件是分开的。

目录结构是这样的:

项目名称

  • _初始化_.py
  • 应用
  • _初始化_.py
  • 应用1
  • 应用2
  • 第三方
  • _初始化_.py
  • lib1
  • lib2
  • 设置
  • _初始化_.py
  • installed_apps.py
  • 路径.py
  • 模板.py
  • 语言环境.py
  • ...
  • urls.py

每个应用都是这样

  • _初始化_.py
  • 管理员
  • _初始化_.py
  • 文件1.py
  • 文件2.py
  • 模特
  • _初始化_.py
  • 模型1.py
  • 模型2.py
  • 测试
  • _初始化_.py
  • 测试1.py
  • 测试2.py
  • 观点
  • _初始化_.py
  • view1.py
  • view2.py
  • urls.py

如何使用 Sphinx 自动生成文档?

我想要这样的东西 对于每个设置模块或 INSTALLED_APPS(不是以 django.* 或 3rdparty.* 开头)给我一个基于文档字符串的自动文档输出。

在 git commit 之前自动生成文档并运行测试

顺便说一句。 我尝试用

手动处理 .rst 文件
.. automodule:: module_name
   :members:

但是对于这么大的项目来说很糟糕, 它不适用于设置

有没有autogen方法之类的?

我不依赖于 Sphinx,是否有更好的解决方案来解决我的问题?

最佳答案

关于python - Django Sphinx 自动模块——基础知识,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/5301218/

相关文章:

python - list.extend 和列表理解

python - Django:无法在管理面板中注册模型

python - 如何修复 django 1.5 中的 localflavor 弃用警告?

python - 如何使用 Intersphinx 引用特定文档中的类?

android - 如何将 'Options'添加到gradlew帮助-任务文档

Python 列出要列出的字符串

python - 模块级别的上下文管理资源

c++ - 氧优化

python - 抓取网页的 "preview"- Python

javascript - react : how to pass in URLs for REST APIs