开发者

sphinx autodoc help

开发者 https://www.devze.com 2023-02-15 10:44 出处:网络
Trying to use autdoc extension of sphinx but its n开发者_高级运维ot working. i kept \"docs\" folder in djano project folder. its not generating docs for my module.Also i am not sure how does auto-todo

Trying to use autdoc extension of sphinx but its n开发者_高级运维ot working. i kept "docs" folder in djano project folder. its not generating docs for my module. Also i am not sure how does auto-todo works.


Without seeing your index.rst file we can only guess, and my guess would be missing something like this:

.. automodule:: myproject.myapp
    :members:

Where of course you replace myproject and myapp with your apps.

You can also try using this very new project http://pypi.python.org/pypi/django-sphinx-autodoc/0.0 which is so new it's at version 0.0!

Here are some blog posts discussing how to use 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

0

精彩评论

暂无评论...
验证码 换一张
取 消