Skip to content

Commit 825d831

Browse files
author
GitHub Actions
committed
Update documentation scripts and workflows
1 parent fcf0f3c commit 825d831

11 files changed

Lines changed: 649 additions & 1300 deletions

.github/scripts/build_docs.py

Lines changed: 0 additions & 54 deletions
This file was deleted.

.github/scripts/build_docs.sh

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
#!/bin/bash
2+
3+
# Script para ejecutar el proceso de copia de documentación de hardware
4+
# Ubicación: .github/scripts/build_docs.sh
5+
# Uso: .github/scripts/build_docs.sh
6+
7+
set -e # Salir si hay algún error
8+
9+
echo " Iniciando construcción de documentación..."
10+
11+
# Obtener la ruta del directorio del proyecto (3 niveles arriba desde .github/scripts)
12+
PROJECT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
13+
cd "$PROJECT_DIR"
14+
15+
echo " Directorio del proyecto: $PROJECT_DIR"
16+
17+
# Verificar que Python está disponible
18+
if ! command -v python3 &> /dev/null; then
19+
echo " Python3 no está instalado"
20+
exit 1
21+
fi
22+
23+
# Crear directorio temporal para el entorno virtual
24+
TEMP_VENV=$(mktemp -d)
25+
echo " Creando entorno virtual temporal en: $TEMP_VENV"
26+
27+
# Crear entorno virtual
28+
python3 -m venv "$TEMP_VENV"
29+
30+
# Activar entorno virtual
31+
echo " Activando entorno virtual..."
32+
source "$TEMP_VENV/bin/activate"
33+
34+
# Instalar dependencias
35+
echo " Instalando dependencias..."
36+
pip install --upgrade pip --quiet
37+
pip install Jinja2 --quiet
38+
39+
# Ejecutar script de copia
40+
echo " Ejecutando script de copia..."
41+
python3 .github/scripts/copy_hardware_docs.py
42+
43+
# Limpiar entorno virtual temporal
44+
echo " Limpiando entorno virtual temporal..."
45+
deactivate
46+
rm -rf "$TEMP_VENV"
47+
48+
# Verificar que los archivos se generaron correctamente
49+
if [ -f "docs/index.html" ]; then
50+
echo " Documentación generada exitosamente!"
51+
echo " Archivos generados:"
52+
echo " - docs/index.html (página principal)"
53+
echo " - docs/hardware/ (archivos copiados)"
54+
55+
# Mostrar estadísticas
56+
if [ -d "docs/hardware" ]; then
57+
file_count=$(find docs/hardware -type f | wc -l)
58+
echo " Total de archivos copiados: $file_count"
59+
fi
60+
61+
else
62+
echo " Error: No se pudo generar la documentación"
63+
exit 1
64+
fi
65+
66+
echo " ¡Proceso completado!"
67+
echo " Para ver la documentación, abre docs/index.html en tu navegador"

.github/scripts/clean_docs.sh

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
#!/bin/bash
2+
3+
# Script para limpiar archivos generados de documentación
4+
# Ubicación: .github/scripts/clean_docs.sh
5+
# Uso: .github/scripts/clean_docs.sh
6+
7+
set -e # Salir si hay algún error
8+
9+
echo " Limpiando documentación generada..."
10+
11+
# Obtener la ruta del directorio del proyecto (3 niveles arriba desde .github/scripts)
12+
PROJECT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/../.." && pwd)"
13+
cd "$PROJECT_DIR"
14+
15+
echo " Directorio del proyecto: $PROJECT_DIR"
16+
17+
# Verificar que el directorio docs existe
18+
if [ ! -d "docs" ]; then
19+
echo " Directorio docs no existe, no hay nada que limpiar"
20+
exit 0
21+
fi
22+
23+
# Eliminar todo el contenido del directorio docs excepto archivos específicos
24+
echo " Eliminando contenido del directorio docs..."
25+
26+
# Contar archivos antes de limpiar
27+
files_before=$(find docs -type f | wc -l)
28+
dirs_before=$(find docs -type d | wc -l)
29+
30+
# Eliminar todos los archivos y subdirectorios generados
31+
# Mantener solo: .gitkeep, README.md (si existen)
32+
find docs -mindepth 1 -maxdepth 1 ! -name ".gitkeep" ! -name "README.md" -exec rm -rf {} +
33+
34+
# Contar archivos después de limpiar
35+
files_after=$(find docs -type f | wc -l)
36+
dirs_after=$(find docs -type d | wc -l)
37+
38+
# Mostrar estadísticas
39+
files_deleted=$((files_before - files_after))
40+
dirs_deleted=$((dirs_before - dirs_after))
41+
42+
echo " Eliminados: $files_deleted archivo(s) y $dirs_deleted directorio(s)"
43+
44+
# Verificar el estado final
45+
if [ -d "docs" ]; then
46+
remaining_files=$(find docs -mindepth 1 -type f ! -name ".gitkeep" ! -name "README.md" | wc -l)
47+
if [ "$remaining_files" -eq 0 ]; then
48+
echo " Directorio docs limpiado completamente"
49+
else
50+
echo "ℹ Quedan $remaining_files archivo(s) protegidos en docs"
51+
fi
52+
fi
53+
54+
echo " Limpieza completada!"

.github/scripts/config.sh

Lines changed: 0 additions & 41 deletions
This file was deleted.

0 commit comments

Comments
 (0)