Construir Documentación

Ek sajlaqob' eh ej tuxtajilab' ajtijalal Sphinx dokumentasion Parrot tz'ijil. We will cover setting up a virtual environment (venv), installing pip and using requirements.txt

Note

Tz'iij ku kutijilab nawuj, manchen awajilab ilo ajil.

Configuración chi'inchik

"Kuxu'n chi'ij ixkato'ob: Ximanki chak kixkabéel ixkatol tiisíin ch'ol, kex uchic uchil taajil:",
```
git clone --recursive https://spacecruft.org/deepcrayon/parrot-wtf
```
K'asya k'ankaj ruk'ik: Pich tz'ij chan chuumil, chak uinal jolchui uinal ch'aakal iluj ch'aakal iluj ichil uinal ch'aakal iluj ch'aakal iluj ichil uinal ch'aakal iluj ch'aakal iluj ichil.
```
cd parrot-wtf
```

Instalar python3-venv (apt): Esto es necesario para crear un entorno virtual. Ejecuta 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): Diríjase al directorio raíz de su proyecto y ejecute:
```
python3 -m venv venv
```
Activar el entorno virtual: Antes de instalar cualquier paquete, activa el entorno virtual ejecutando:
```
source venv/bin/activate
```
"Utz'ij requirements.txt: Xajil paq'o'ob'al yujoy loxik ikech retsinalo'ob'al. Retse pip, ujal run:"
```
pip install -r requirements.txt
```

"Instalar submódulos: Instala 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 la documentación: 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
```

Tujal al Ch'aakchikel jach kuukojol

Antu k'asina la documentación, yakinal teyuj ch'a yaq'ijab'al ejusmente HTML nija uchux neech build/html directory. Nima yakinal teyuj uploadet al tuláakal ch'a web.

Txipe .env ra k'ux ximel alojamat, rsync alojamat jach rech nis, como:

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

Ejecuta el siguiente comando para rsync en el servidor:

./scripts/rsync-parrot-wtf

Xinuch kub'aji'ob tzij ri HTML cha'ab'al ajtijil u asajk'o'ob ch'ulub'al bejtal.

Note

Tz'utujil ajtijab'ilo'ob' tzeejal ri txujilob' ri AI machin translations chu'umil yalo'ob'.