Open vAIR DOCS

Документация к проекту Open vAIR.

Есть 2 способа взаимодействия с готовым вариантом документации.

Запуск документации, без установки проекта

1. Скачайте репозиторий проекта:

   git clone https://github.com/Aerodisk/openvair-docs.git

2. Перейдите в папку проекта документации:

   cd openvair-docs

3. Подготовьте venv

   uv venv --seed 
   uv sync

4. (Опционально) Укажите на каком адресе должен будет запускаться проект документации в файле mkdocs.yml

   Если пропустить этот пункт, то автоматически будет использован адрес: http://127.0.0.1:8000/

   Пример заполнения в mkdocs.yml:

   ...
    dev_addr: 123.123.0.1:8001
   ... 

5. Запустите проект

   mkdocs serve

   Открыть документацию и ознакомиться с ней можно по установленному в конфигурации адресу

Сборка в проект

Далее описан процесс ручной установки документации в проект. В типовом случае, документация устанавливается автоматически вместе с проектом

1. Скачайте репозиторий проекта:

   git clone https://github.com/Aerodisk/openvair-docs.git

2. Перейдите в папку проекта документации:

   cd openvair-docs

3. Запустите скрипт установки:

   ./install.sh

   Документация будет находиться по шаблону адреса https://{host}:{port}/docs, подставляя значения из ../openvair/project_config.toml:

   [web_app]
   host = '123.123.0.1'
   port = 8000

   Пример: https://123.123.0.1:8000/docs