django - 狮身人面像自动文档帮助

Question

尝试使用 sphinx 的 autdoc 扩展，但它不起作用。我将“docs”文件夹保存在 djano 项目文件夹中。它没有为我的模块生成文档。我也不确定自动待办事项是如何工作的。

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