Guidedog Manual 0.2.0
Idioma
En esta página
Guidedog / Documentación 0.2.0

Cómo funciona un proyecto

La raíz es el directorio de conf.toml. root_doc inicia el orden de lectura. Guidedog descubre documentos, los lee, resuelve relaciones y publica una generación completa.

Descubrir fuentes, leer documentos, resolver referencias, renderizar y publicar.
Fig. 2 La construcción separa el descubrimiento, la semántica, la presentación y la publicación.

Documentos y recursos

El sufijo elige el lector. RST y Markdown del proyecto comparten grafo. Las imágenes y descargas son recursos; se copian los utilizados. Los recursos del tema van en html_static_path. Las inclusiones deben permanecer en las fuentes o include_roots.

Proyectos separados

Separa manual y diseños: tienen lectores y órdenes distintos. Cada proyecto mantiene configuración, plantillas, caché y salida. Así se usan docs/manual y docs/gds en Guidedog.

Compilación incremental

Guidedog registra entradas y consultas de cada salida. Relee fuentes cambiadas, invalida usuarios de dependencias modificadas y puede afectar todas las páginas al cambiar plantillas. Los documentos intactos pueden cargarse del objeto guardado.

La caché es evidencia del build anterior, no la fuente de verdad. -E descarta el entorno guardado para el siguiente build; -a escribe todas las salidas. Resuelven problemas distintos.

\[\text{reutilización} = \text{mismas entradas} \land \text{mismas consultas} \land \text{salida existente}\]

Una marca temporal de plantilla también es entrada. Un minuto actual puede cambiar la página sin cambiar la prosa. Usa SOURCE_DATE_EPOCH para fijar la hora de construcción.

Publicación

La construcción escribe en un directorio temporal vecino. Lo completa, persiste archivos y registros y cambia generaciones. El lector ve la anterior o la nueva completas. La siguiente construcción resuelve commits interrumpidos. Diseño y obligaciones de prueba están en Publicar una generación completa.