Построить документацию

Этот документ объясняет, как создать документацию Sphinx для приложения Parrot. Мы обсудим настройку виртуальной среды (venv), установку pip и использование requirements.

Примечание

Парот находится в ранней стадии разработки и не готов для конечных пользователей.

Инструкции по установке

Клонировать репозиторий: Сначала клонируйте репозиторий, используя эту команду:
```
git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
```
Перейти в каталог репозитория: После клонирования перейдите в корневой каталог проекта, запустив:
```
cd parrot-wtf
```
Установите python3-venv (apt): Это необходимо для создания виртуальной среды. Выполните эту команду:
```
sudo apt update
sudo apt install docutils gettext python3-pip python3-venv
# To build PDFs with LaTeX
sudo apt install texlive-full xindy
```
Настройте виртуальное окружение (venv): Перейдите в корневой каталог вашего проекта и запустите:
```
python3 -m venv venv
```
Активируйте виртуальное окружение: Перед установкой любых пакетов, активируйте виртуальное окружение, запустив:
```
source venv/bin/activate
```
Используйте requirements.txt: В этом файле содержится список зависимостей проекта. Для установки их с помощью pip, выполните:
```
pip install -r requirements.txt
```

Установить подмодули: Установите другие подмодули репозитория Parrot для включения их документации.

pip install -r datasets/requirements.txt
pip install -r extension/requirements.txt
pip install -r ide/requirements.txt
pip install -r models/requirements.txt

pip install -e datasets

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

Очистить существующую сборку: Если ранее вы строили документацию, начните с очистки старых файлов сборки с помощью этой команды:
```
make clean
```
Сборка HTML-версии документов: Приложение Parrot использует Sphinx для создания документации. Для создания версии HTML запустите:
```
make html
```
Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:
```
make help
```

Отправить на веб-сервер

После сборки документации вы найдете файлы HTML в каталоге build/html. Это файлы, которые необходимо передать на ваш веб-сервер.

Редактировать .env для установки URL-адреса сервера, используемого rsync, например:

URL="parrot.wtf:/var/www/html/parrot-wtf/"

Выполните следующую команду для rsync на сервер:

./scripts/rsync-parrot-wtf

Это отправит все HTML-файлы в каталоге build/html на ваш основной сервер.

Примечание

Документация Parrot написана на английском языке и использует машинный перевод искусственного интеллекта для других языков.