dreamkas/pirit_documentation

HTML

Генератор документации для Пирит2Ф и FM16

Для работы скриптов требуется

Python 3

Удобный редактор для Markdown:

[Haroopad] (http://pad.haroopress.com/user.html)

Генерирование документации

Для генерирования документации запустить make_doc.py. Сгенерированная документация будет помещена в папку output.

Подробнее о правилах ведения документации в Wiki

Файлы

documentation_pirit_fm.md - основной файл с документацией
make_doc.py - скрипт генерирования документации
backdoc.py - библиотека генерации html
output - директория со сгенерированной документацией

Разметка

Для разделения секций, относящихся к разным документам, используется управляющая строка следующего вида:

<<<<<< Метка 1 [еще метки]

Список используемых меток:

Pirit2f 1.05
Pirit2f 1.2
FM16 1.05
FM16 1.2
Punix 1.05
Punix 1.2
common

Пример

Текст для всех документов

<<<<<< FM16 1.05 Pirit2f 1.05
Текст только для FM16 и Пирит2Ф с ФФД 1.05

<<<<<< Pirit2f 1.2
Текст только для Пирит2Ф 1.2

<<<<<< common
Текст для всех документов

<<<<<< (скобки и пробел, нет ни одной метки в строке)
Этот текст не будет включен ни в один документ

<<<<<< FM16 1.2 Pirit2f 1.2
Текст только для FM16 и Пирит2Ф с ФФД 1.2