используя утилиту Sphinx sphinx-apidoc для автоматической генерации документации из кода python

Мне интересно, что такое формат комментариев, чтобы иметь самодокументирующий код, используя служебную программу sphinx-apidoc от Sphinx. Я могу получить эту утилиту для создания набора файлов reStructuredText для каждого файла python, но эти файлы по-прежнему необходимо заполнить. Я ищу способ получить эту утилиту или другую служебную программу Sphinx для создания документации из коды python docstrings. Я понимаю, что это потребует ознакомления с обычным форматом комментариев, и я надеюсь, что будет указан этот справочный материал. Благодаря!

One Solution collect form web for “используя утилиту Sphinx sphinx-apidoc для автоматической генерации документации из кода python”

mzjn, спасибо за комментарий. ваша вторая ссылка предоставила некоторое представление о том, как форматировать docstrings .

кроме того, я не смог пометить правильные ответные подсказки sphinx-quickstart (как указано в ссылке, http://pythonhosted.org/an_example_pypi_project/sphinx.html#full-code-example ). в частности, ответить « да» на:

autodoc: автоматически вставлять docstrings из модулей (y / N) [n]:

также, как указано в ссылке, http://codeandchaos.wordpress.com/2012/07/30/sphinx-autodoc-tutorial-for-dummies/ , а также комментарии conf.py , мне нужно было добавить расположение модулей в путь к системе. Я должен заметить, что я столкнулся с проблемой добавления имен файлов. когда я добавлял пути, где могли быть найдены модули, все работало отлично.

Python - лучший язык программирования в мире.