Документация Picodata

В репозитории расположены исходные файлы проекта MkDocs, с помощью которого генерируется статический сайт документации Picodata — https://docs.picodata.io/picodata/

Содержание

• Тестирование документации Picodata
  • Установка Pipenv
  • Клонирование репозитория
  • Установка зависимостей
  • Запуск локального сервера MkDocs
  • Cборка документации
  • Линтинг скриптов Python
  • Форматирование скриптов Python
  • Активация виртуального окружения Pipenv
  • Добавление зависимостей
• Запуск документации Picodata в Docker

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

Установка Pipenv

Откройте терминал, введите команду:

pip install pipenv

Для установки Pipenv потребуются Python не ниже версии 3.7 и актуальный pip

Подробнее — Pipenv Installation

Клонирование репозитория

Откройте терминал, последовательно введите команды:

git clone https://git.picodata.io/picodata/picodata/docs.git
cd docs

Установка зависимостей

Введите команду:

pipenv sync -d

С помощью этой команды будут установлены группы модулей [packages] и [dev-packages], указанные в Pipfile

Запуск локального сервера MkDocs

Введите команду:

pipenv run serve

Локальный сайт документации Picodata будет доступен по адресу http://127.0.0.1:8000

Для остановки локального сервера MkDocs нажмите Ctrl + Z

Cборка документации

Введите команду:

pipenv run build

С помощью этой команды сайт документации будет собран в «строгом» режиме — с флагом -s / --strict

Полученную сборку можно запустить, например, с помощью модуля http.server. Введите команду:

python -m http.server -d site --bind 127.0.0.1

Линтинг скриптов Python

Введите команду:

pipenv run lint

Хуки из папки hooks будет последовательно проверены с помощью следующих модулей:

• flake8
• black
• mypy

Форматирование скриптов Python

Введите команду:

pipenv run fmt

Форматирование хуков из папки hooks будет скорректировано форматтером black

Активация виртуального окружения Pipenv

Введите команду:

pipenv shell

Активированное виртуальное окружение Pipenv позволит использовать напрямую команды MkDocs и остальных установленных модулей

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

Добавление зависимостей

Введите команду:

pipenv update <package>

где <package> — название добавляемого модуля

Команда добавляет модуль в Pipfile и Pipfile.lock, затем устанавливает его в виртуальное окружение Pipenv

Запуск документации Picodata в Docker

С помощью Dockerfile можно собрать сайт документации Picodata внутри образа Docker, затем запустить образ в контейнере

Создание образа picodocs:

docker build -f docker/static/Dockerfile -t picodocs --no-cache .

Запуск образа picodocs в контейнере picodocs:

docker run --name picodocs -p 127.0.0.1:8000:8000 picodocs

Запущенный в контейнере picodocs сайт документации Picodata будет доступен по адресу http://127.0.0.1:8000

Удаление контейнера picodocs:

docker rm -f picodocs