Interested Article - Sphinx (генератор документации)

Sphinx — это генератор документации , который преобразует файлы в формате reStructuredText в HTML website и другие форматы ( PDF , EPub и man ). Он использует ряд расширений для reStructuredText (например, для автоматической генерации документации по исходному коду, создания математических формул или подсветки исходного кода). Первый публичный релиз (версия 0.1.61611) был объявлен 21 марта 2008 года. Он был разработан и широко используется для документирования языка программирования Python , а также его дополнительных модулей.

С момента своего появления в 2008 году, Sphinx был принят многими важными Python-проектами: Bazaar , SQLAlchemy , , Sage , SciPy , Django и Pylons ; также он используется для документирования Blender Python API. Для облегчения поддержки документирования программного обеспечения был создан проект . Он автоматизирует процесс создания и загрузки Sphinx-документации после каждой фиксации изменений в исходном коде. Проект спонсируется Python Software Foundation .

См. также

Ссылки

  1. . Дата обращения: 18 апреля 2023. 14 марта 2023 года.
  2. And now for something completely Pythonic... . Georg Brandl. Дата обращения: 3 апреля 2011. 26 января 2013 года.
  3. . Python documentation . Python Software Foundation. Дата обращения: 3 апреля 2011. 26 января 2013 года.
  4. Blender Wiki . Blender Foundation. Дата обращения: 6 апреля 2011. Архивировано из 26 января 2013 года.
  5. . Surfing in Kansas . Eric Holscher. Дата обращения: 6 апреля 2011. 26 января 2013 года.
  6. . Python Software Foundation News . Python Software Foundation. Дата обращения: 6 апреля 2011. 26 января 2013 года.

Литература

  • — официальный сайт Sphinx
  • (см. )
  • (сгенерировано с помощью Sphinx)
  • (рус.)
Источник —

Same as Sphinx (генератор документации)