Este repositorio está destinado a escribir y gestionar la Documentación Oficial del plugin de QGIS Giswater, que es un sistema de información geográfica para el desarrollo de proyectos de ingeniería hidráulica y sanitaria.
La documentación se encuentra en el directorio docs y está escrita usando Sphinx con archivos fuente en formato reStructuredText.
La última documentación de Giswater se encuentra disponible en el siguiente enlace: Documentación de Giswater
- Instala los paquetes necesarios en tu sistema operativo.
Debes de tener en tu sistema operativo instalado los siguientes paquetes:
- git
- python (>= 3.9)
Puedes instalarlos usando el gestor de paquetes de tu sistema operativo.
- Clona el repositorio en tu máquina local.
git clone https://github.com/Giswater/Giswater-Documentation.git- Accede al directorio del repositorio.
cd Giswater-DocumentationLa mejor forma de construir la documentación es usando el entorno virtual de Python que viene incluido en el repositorio. Para ello sigue los siguientes pasos según tu sistema operativo.
Para crear el entorno virtual y activarlo, ejecuta los siguientes comandos:
Nota: Si no tienes instalado Python 3.9 o superior, puedes instalarlo usando el gestor de paquetes de tu sistema operativo.
python3 -m venv venvAhora activa el entorno virtual.
source venv/bin/activateEjecuta el siguiente comando para instalar las dependencias necesarias.
pip install -r REQUIREMENTS.txtAhora puedes construir la documentación usando el siguiente comando.
make htmlLa documentación se construirá en el directorio docs/build/html/en/.
Si quieres ver la documentación en tu navegador, ejecuta el siguiente comando.
make openPara crear el entorno virtual y activarlo, ejecuta los siguientes comandos:
python -m venv venvAhora activa el entorno virtual.
venv\Scripts\activateEjecuta el siguiente comando para instalar las dependencias necesarias.
pip install -r REQUIREMENTS.txtAhora puedes construir la documentación usando el siguiente comando.
./make.bat htmlLa documentación se construirá en el directorio docs\build\html\en\.
Si quieres ver la documentación en tu navegador, ejecuta el siguiente comando.
./make.bat openPara traducir la documentación a otros idiomas, revisa la lista de idiomas disponibles en el archivo docs_conf.yml.
Actualmente estamos usando Weblate para gestionar las traducciones de la documentación. Si quieres colaborar en las traducciones, puedes hacerlo en el siguiente enlace: Traducciones de la documentación.
El proceso esta automatizado con workflows de GitHub Actions y scripts personalizados.