Каковы отношения между docutils и Сфинксом?
Кажется, существует множество инструментов документации для Python. Другой, что я натыкался, является epydoc. Кажется, что Сфинкс является фактическим стандартом, потому что это используется для генерации официальных документов Python. Кто-то может разобраться в текущем состоянии инструментов документации Python для меня?
22
задан tiktuk 22 April 2011 в 16:56
поделиться
1 ответ
epydoc и Sphinx - это разные типы инструментов.
Они одинаковы в том, что они:
- Оба используют ReST через Docutils .
- Оба они очень похожи на Pythonic
- Оба могут генерировать документацию в формате HTML и PDF
Они различаются по своей направленности.
- Epydoc сосредоточен на документации API (для разработчиков). С Epydoc вы получите больше результатов быстрее. Вы указываете его на свой исходный код, и вы что-то получаете. Это то, что я хочу от инструмента документации API.
- Sphinx ориентирован на общую (пользовательскую) документацию. Хотя Sphinx действительно извлекает много информации из вашего исходного кода, вам нужно добавить в него немного больше. Sphinx может создавать документацию по API, но это не так просто, и IMO не так хорошо справляется со своей задачей, как Epydoc. Я знаю, что некоторые не согласятся, потому что Sphinx выбран для Python . НО, это зависит от того, сколько работы вы хотите вложить в это. Я люблю Sphinx за общую документацию.
Так что это зависит от того, сколько работы вы хотите вложить в это и что вы документируете.
24
ответ дан 29 November 2019 в 05:21
поделиться
Другие вопросы по тегам: