Read the Docs

Материал из Викиучебника — открытых книг для открытого мира

w:en:Read the Docs - веб-сервис для генерации документации, построенный в рамках концепции Docs as code. Основным результатом работы сервиса является документация в HTML-формате, а также PDF-документ (все это размещается на сайте и он выступает таким образов в ролик хостинга документации). При работе с публичным проектом является бесплатным.

Особенности Read the Docs
  • В качестве генератора используется Sphinx.
  • Для разметки текста используется w:reStructuredText.
  • Исходные файлы, на основании которых генерится документация хранятся на w:Github.
  • Генерация PDF осуществляется с помощью инструментов w:LaTex.

Начало работы[править]

Начало работы подробно описано в учебнике на официальном сайте[1].

Для использования русского языка в свойствах проекта на Read the Docs необходимо выбрать русский язык. Иначе генерация PDF с проектом содержащим русские буквы будет приводить к ошибке.

Конвертация из формата MS Word[править]

Выполняется с применением консольного приложения w:pandoc.

pandoc test.docx -t rst -o test.rst

Ссылки[править]

PDF

Примечания[править]

  1. Tutorial