Тестовый портал документации продукта Picodata

Здесь живёт проект Mkdocs, с помощью которого генерируется статичный сайт документации для Picodata. Содержимое репозитория попадает на сайт docs.binary.picodata.io/picodata. При сборке через make все операции происходят в отдельном окружении, созданном pipenv.

Cборка проекта

make build

Локальный запуск

make run

Проверка корректности

make lint

По умолчанию сайт будет доступен по адресу http://127.0.0.1:8000.

Для выхода из временного окружения Python нажмите Ctrl+D.

Сборка в Docker

В данном репозитории имееется Dockerfile, с помощью которого можно собрать и запустить сайт внутри контейнера. Можно использовать следующие команды:

docker build -f docker/static/Dockerfile -t test-project-mkdocs --no-cache .
docker run -p 8080:8080 test-project-mkdocs:latest