django sphinx automodule —基础知识[关闭]

Question

关闭。这个问题需要更多focused。它当前不接受答案。

---

是否要改善此问题？更新问题，使其仅按editing this post专注于一个问题。

关闭2年前。

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

目录结构类似于：

project_name

• __ init __。py
• 应用
  • __ init __。py
  • app1
  • app2
• 第三方
  • __ init __。py
  • lib1
  • lib2
• 设置
  • __ init __。py
  • installed_apps.py
  • path.py
  • templates.py
  • locale.py
  • ...
• urls.py

每个应用都是这样

• __ init __。py
• 管理员
  • __ init __。py
  • file1.py
  • file2.py
• 型号
  • __ init __。py
  • model1.py
  • model2.py
• 测试
  • __ init __。py
  • test1.py
  • test2.py
• 意见
  • __ init __。py
  • view1.py
  • view2.py
• urls.py

如何使用狮身人面像自动生成文档？

我想要这样的东西对于每个设置模块或INSTALLED_APPS（不是以django。*或3rdparty。*开头），请根据文档字符串为我提供自动文档输出

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

btw。我尝试用

手工制作.rst文件

.. automodule:: module_name
   :members:

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

是否有自动生成方法？

我不受狮身人面像的束缚，我的问题有更好的解决方案吗？

Answer 1

1. 请参阅Automatically Generating Documentation for All Python Package Contents。

2. 即将发布的Sphinx 1.1版本包括sphinx-apidoc.py脚本。

Answer 2

django-sphinx-autodoc在这里可能会有所帮助。

摘自文档：

如何运作

将generate_autodoc.py文件复制到您的项目目录中，然后执行它。

它将刮除列出的每个应用程序中的所有.py文件INSTALLED_APP，然后在DS_ROOT/modules.rst中添加自动模块。

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

• 内部应用程序是位于项目中的应用程序目录
• 外部应用程序是位于您某处的应用程序pythonpath（最好在您的virtualenv中）

良好做法

在应用程序的__init__.py文件中添加文档字符串以对其进行描述。django-sphinx-autodoc将自动为您抓取。