Construir documentación

Este documento explica cómo construir la documentación de Sphinx para la aplicación Parrot. Abordaremos la configuración de un entorno virtual (venv), la instalación de pip y el uso de requirements.txt,

Nota

El lorito está en desarrollo temprano, no está listo para usuarios finales.

Configuración de instrucciones

Clona el repositorio: Primero, clona el repositorio utilizando este comando:
```
git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
```
Cambiar el directorio al repositorio: Después de clonar, navegue hasta el directorio raíz del proyecto ejecutando:
```
cd parrot-wtf
```

Instalar python3-venv (apt): Se requiere para crear un entorno virtual. Ejecute este comando:

sudo apt update
sudo apt install docutils gettext python3-pip python3-venv
# To build PDFs with LaTeX
sudo apt install texlive-full xindy

Configurar un entorno virtual (venv): Navegue hasta el directorio raíz de su proyecto y ejecute:
```
python3 -m venv venv
```
Active el entorno virtual: Antes de instalar cualquier paquete, active el entorno virtual ejecutando:
```
source venv/bin/activate
```
Utilice requirements.txt: Este archivo contiene una lista de dependencias del proyecto. Para instalarlas con pip, ejecute:
```
pip install -r requirements.txt
```

Instalar Submódulos: Instale otros submódulos del repositorio de Parrot para incluir su documentación.

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

Construyendo la documentación

Limpiar la compilación existente: Si ha construido previamente la documentación, comience limpiando los archivos de compilación antiguos con este comando:
```
make clean
```
Construye la versión HTML de los documentos: La aplicación Parrot utiliza Sphinx para generar su documentación. Para crear la versión HTML, ejecuta:
```
make html
```
Other useful ``make`` commands: There are other make commands available in the Makefile. You can view them by running:
```
make help
```

Enviar al servidor web

Después de construir la documentación, encontrarás los archivos HTML en el directorio build/html. Estos son los archivos que debes subir a tu servidor web.

Edita .env para establecer la URL del servidor que utilizará rsync, por ejemplo:

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

Ejecute el siguiente comando para rsync en el servidor:

./scripts/rsync-parrot-wtf

Esto enviará todos los archivos HTML en build/html al servidor principal.

Nota

La documentación de Parrot está escrita en inglés y utiliza la traducción automática de máquina para otros idiomas.