Для создания документации используется генератор статических сайтов MkDocs с темой оформления Material for MkDocs.
- Установить Python 3.x
- Запустить скрипт
install.cmd
для создания virtual environment и установки необходимых пакетов - Запустить скрипт
serve.cmd
для запуска локального сервера mkdocs - Для превью документации открыть в браузере адрес http://localhost:8000/
По мере необходимости, запускать скрипт install.cmd
для обновления пакетов.
Скрипт build.cmd
предназначен для создания оффлайн версии документации (будет создана во вложенной папке site).