#python #documentation #docstring #pep
#python #Документация #строка документа #бодрость духа
Вопрос:
Я хочу знать, как правильно документировать модуль python с использованием формата reStructuredText. В PEP есть общее описание, но нет объяснения формата документации модуля.
Комментарии:
1. возможно, вам следует использовать Sphinx для создания документации: Руководство по стилю для документации на основе Sphinx
2. В чем основное различие между reStructuredText и Sphinx?
3. Sphinx генерирует документацию на основе reStructuredText, которым вы украсили свой API.
4. reStructuredText — это только формат файла / данных, такой как HTML, markdown и т.д. Sphinx — это инструмент, который может получать все строки документации из кода Python и генерировать документацию в формате HTML, PDF и т.д.