README.md

RBKmoney public docs

После деплоя документация будет доступна по адресу https://rbkmoney.github.io/docs/

Сборка

Для генерации статического сайта с документацией мы используем MkDocs. Убедитесь, что в используемой вами системе наличествует make, актуальная версия Python и его верный менеджер pip.

Для начала установите необходимый инструментарий:

pip install -r requirements.txt

После чего вы уже можете запускать локальный сервер для разработки с готовой документацией:

mkdocs serve --livereload

Диаграммы

Для генерации картинок из диаграмм на языке PlantUML мы используем простой в использовании platinum-toolset. Будьте внимательны, для работы этому инструменту необходима Java Runtime.

Установить его можно при помощи:

make install-toolset

Теперь, чтобы сгенерировать изображения png и svg из файлов с диаграммами wsd, достаточно всего лишь:

make