Собирака

Собирака — сборщик документации, разработанный в Documentat. Собирака основана на популярных проектах с открытым исходным кодом, таких как Pandoc и WeasyPrint, но добавляет к ним свои правила и проверки.

Сборщик ориентирован на подход «docs as code» и поддерживает Markdown и reStructuredText, в том числе с возможностью совмещать их в одном проекте. Вне зависимости от языка разметки, Собирака проверяет корректность всех внутренних ссылок в рамках проекта. Также в исходных файлах поддерживаются условия, инклюды и другие конструкции Jinja.

Готовая документация собирается в форматах HTML и PDF. Для формата HTML поддерживается поиск по документации. В рамках одного проекта возможно собирать несколько документов, в том числе на разных языках.

Собирака предоставляет богатые возможности по кастомизации процесса сборки: от шаблонов для HTML до произвольного кода на Python.

Документацию можно собирать как на компьютере технического писателя, так и на любом сервере. Documentat распространяет готовые Docker-образы Собираки, с помощью которых можно с минимальными усилиями добавить сборку документации в ваш процесс CI.

Быстрый старт #

1. Установите Собираку в виде пакета Python или образа Docker.
2. Создайте файл конфигурации для вашего проекта.
3. Разместите файлы Markdown или ReST согласно требуемой структуре.
4. Выполните автоматические проверки качества текста.
5. Запустите сборку документации в формат HTML или PDF.
6. При необходимости кастомизируйте оформление HTML и PDF.

Документация Собираки написана на Markdown и собрана Собиракой.