Сфинкс является инструментом, который позволяет легко создавать, умный и красивый документации для Python проектов (или других документов, состоящих из нескольких источников ReStructuredText), написанных Georg Брандл. Проект изначально был создан, чтобы перевести новую документацию Питона, но теперь были очищены в надежде, что она будет полезна для многих других проектов.
Сфинкс использует ReStructuredText в качестве языка разметки, и многие из ее сильных сторон приходят от силы и прямолинейность ReStructuredText и его разбора и перевода люкс, в Docutils.
Хотя это еще под постоянным развитием, следующие особенности уже присутствуют, отлично работает и можно увидеть "в действии" в Python Docs:
& NBSP; * Выходные форматы: HTML (в том числе Windows, HTML Help) и LaTeX, для печатных версий PDF
& NBSP; * Широкие перекрестных ссылок: семантическая разметка и автоматические ссылки для функций, классов, Глоссарий терминов и аналогичных частей информации
& NBSP; * Иерархическая структура: легкий определение дерева документа, с автоматическими ссылками на братьев и сестер, родителей и детей
& NBSP; * Автоматические индексы: общий индекс, а также индекс модуль
& NBSP; * код обработки: автоматическая подсветка с помощью маркера Pygments
& NBSP; * Различные модули доступны, например, . для автоматического тестирования фрагментов и включения соответственно отформатированных строк документации
Требования
- Python
Комментарии не найдены