请参阅自动生成所有 Python 包内容的文档。
即将推出的 Sphinx 1.1 版本包括 sphinx-apidoc.py 脚本。
See Automatically Generating Documentation for All Python Package Contents.
The upcoming Sphinx 1.1 release includes a sphinx-apidoc.py script.
django-sphinx-autodoc 可能会有所帮助这里。
从文档中：
它是如何工作的复制项目目录中的generate_autodoc.py文件，然后执行它。它将抓取列出的每个应用程序中的所有 .py 文件INSTALLED_APP，然后在 DS_ROOT/modules.rst 中添加自动模块。然后您将看到您的应用程序分为 2 个不同的类别：内部应用程序是位于您的项目中的应用程序目录外部应用程序是位于您的某个位置的应用程序pythonpath（最好在你的 virtualenv 中）良好实践在应用程序的 __init__.py 文件中添加文档字符串来描述它。django-sphinx-autodoc 会自动为您抓取它。
复制项目目录中的generate_autodoc.py文件，然后执行它。
generate_autodoc.py
它将抓取列出的每个应用程序中的所有 .py 文件INSTALLED_APP，然后在 DS_ROOT/modules.rst 中添加自动模块。
.py
INSTALLED_APP
DS_ROOT/modules.rst
然后您将看到您的应用程序分为 2 个不同的类别：
在应用程序的 __init__.py 文件中添加文档字符串来描述它。django-sphinx-autodoc 会自动为您抓取它。
__init__.py
django-sphinx-autodoc will probably be of help here.
From the documentation:
How it worksCopy the generate_autodoc.py file in your project directory, thenexecute it.It will scrape all your .py files in each application listed byINSTALLED_APP, then add automodules in your DS_ROOT/modules.rst.You will then see your applications grouped in 2 different categories:internal application is an application located in your projectdirectoryexternal application is an app which is somewhere in yourpythonpath (preferably in your virtualenv)Good PracticesAdd a docstring in your application's __init__.py file to describe it.django-sphinx-autodoc will automatically scrape it for you.
Copy the generate_autodoc.py file in your project directory, thenexecute it.
It will scrape all your .py files in each application listed byINSTALLED_APP, then add automodules in your DS_ROOT/modules.rst.
You will then see your applications grouped in 2 different categories:
Add a docstring in your application's __init__.py file to describe it.django-sphinx-autodoc will automatically scrape it for you.
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
暂无简介
文章 0 评论 0
接受
发布评论
评论（2）
请参阅自动生成所有 Python 包内容的文档。
即将推出的 Sphinx 1.1 版本包括 sphinx-apidoc.py 脚本。
See Automatically Generating Documentation for All Python Package Contents.
The upcoming Sphinx 1.1 release includes a sphinx-apidoc.py script.
django-sphinx-autodoc 可能会有所帮助这里。
从文档中：
django-sphinx-autodoc will probably be of help here.
From the documentation: