sphinx autodoc帮助

Question

尝试使用sphinx的autdoc扩展但不起作用。我在djano项目文件夹中保留了“docs”文件夹。它没有为我的模块生成文档。另外我不确定auto-todo是如何工作的。

Answer 1

如果没有看到我们只能猜到的index.rst文件，我的猜测就会遗漏：

.. automodule:: myproject.myapp
    :members:

当然，您可以使用自己的应用替换myproject和myapp。

您也可以尝试使用这个非常新的项目http://pypi.python.org/pypi/django-sphinx-autodoc/0.0，它是0.0版本的新版本！

以下是一些讨论如何使用autodoc的博客文章：

http://yml-blog.blogspot.com/2009/06/sphinx-autodoc-and-django-app.html

http://www.toast38coza.com/incomplete-thoughts/setting-up-sphinx-documenter-with-a-django-project-a-quickstart-tutorial