Сфинкс помощь Autodoc - PullRequest
0 голосов
/ 07 марта 2011

Попытка использовать расширение sphx для autdoc, но оно не работает. я сохранил папку "docs" в папке проекта djano. это не генерирует документы для моего модуля. Также я не уверен, как работает auto-todo.

1 Ответ

1 голос
/ 06 июня 2011

Не видя вашего 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 / сфинкс-автодок-и-Джанго-app.html

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

...