RBKmoney public docs

После деплоя документация будет доступна по адресу https://developer.rbk.money/

Сборка

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

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

pip install -r requirements.txt

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

mkdocs serve --livereload

Диаграммы

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

sequencediagram.org
- допополнительная информация для поддержки svg здесь.
- пример использования svg:
  - встроить отображение для html можно с помощью
```
<object data="../../recurring/img/CustomerPayer.svg"> </object>
```
  - управлять размером можно с помощью внесения изменений в .svg (тег <svg>)
```
preserveAspectRatio="xMinYMin meet"
viewBox="0 0 1451 3265">
```
platinum-toolset (язык PlantUML).
- для работы этому инструменту необходима Java Runtime;
- Установить его можно при помощи:
```
make install-toolset
```
- Чтобы сгенерировать изображения png и svg из файлов с диаграммами wsd, достаточно:
```
make
```

Локальное тестирование/ревью изменений

Этап подготовки

Выполняется разово.

Устанавливаем Python c сайта https://www.python.org.

ПРИМЕЧАНИЕ

Необходимы права системного администратора.
Устанавливаем MkDocs, следуя инструкциям с сайта https://www.mkdocs.org/#installation: раздел "Installation".

ПРИМЕЧАНИЕ
- Для того, чтобы проверить установлен ли pip по-умолчанию вместе с Python достаточно ввести в командной строке команду pip или pip3: pip3 не всегда маппится на pip, иногда приходится указывать это явно.
- Во время установки MkDocs с помощью pip (pip install mkdocs или pip3 install mkdocs) может возникнуть сообщение о том, что каталог установлен не в PATH. Добавление в PATH является опциональным шагом: цель — при сборке сайта указывать алиас 'mkdocs' вместо полного пути расположения MkDocs.

Этап тестирования/ревью

Выполняется каждый раз при проверке изменений.