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

Question

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

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

4

python python-sphinx self-documenting-code

Источник

user2225753 26 сен '13 в 20:03

1 ответ

Решение

Другие вопросы по тегам python python-sphinx self-documenting-code

user2225753 27 сен '13 в 20:57 2013-09-27 20:57 · Accepted Answer · 2013-09-27 20:57

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

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

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

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