Лучшие вопросы
Таймлайн
Чат
Перспективы
Sphinx (генератор документации)
Из Википедии, свободной энциклопедии
Remove ads
Sphinx — генератор документации, который преобразует файлы в формате reStructuredText в HTML website и другие форматы (PDF, EPub и man). Он использует ряд расширений для reStructuredText (например, для автоматической генерации документации по исходному коду, создания математических формул или подсветки исходного кода). Первый публичный релиз (версия 0.1.61611) был объявлен 21 марта 2008 года.[2] Он был разработан и широко используется для документирования языка программирования Python, а также его дополнительных модулей.[3]
С момента своего появления в 2008 году, на Sphinx перешли крупные Python-проекты: Bazaar, SQLAlchemy, MayaVi, Sage, SciPy, Django и Pylons; также он используется для документирования Blender Python API.[4]
Remove ads
Для облегчения поддержки документирования программного обеспечения был создан проект Read the Docs[англ.].[5] Он автоматизирует процесс создания и загрузки Sphinx-документации после каждой фиксации изменений в исходном коде. Проект спонсируется Python Software Foundation.[6]
См. также
Ссылки
Литература
Wikiwand - on
Seamless Wikipedia browsing. On steroids.
Remove ads