Mantener esta documentación¶
Hay tres proyectos Guidedog: docs/manual, docs/api y docs/gds. El manual y GDS nacieron de guidedog quickstart. Edita las plantillas generadas directamente. Los registros de diseño no deben estar en el índice del manual.
Compilar el manual¶
Desde la raíz del repositorio:
build/guidedog build html docs/manual -j auto -W
build/guidedog build pdf docs/manual -W
build/guidedog serve docs/manual
El índice del manual incluye toda la referencia API de Odin. El PDF forma un único libro con enlaces entre explicaciones y declaraciones. Tanto el manual como el proyecto API generan la referencia desde lib/. No hay un manuscrito API duplicado que sincronizar.
Para compilar el proyecto de API por separado:
build/guidedog build html docs/api -W
build/guidedog build pdf docs/api -W
Compilar y comprobar las discusiones¶
build/guidedog gds index
build/guidedog gds check
build/guidedog gds build --target=both
La CLI GDS administra metadatos, números, estado y recuperación. Su publicación RST llama al motor del proyecto y produce el sitio HTML completo y un PDF por registro. El selector limita los PDF; el HTML mantiene el catálogo completo. La vista previa seleccionada usa _build/selected/<artifact>/pdf y conserva el catálogo de _build/pdf.
build/guidedog gds build guidedoc-odin --target=pdf
build/guidedog build html docs/gds -W
build/guidedog build pdf docs/gds -W
También funcionan los comandos habituales del proyecto. GDS tiene su propio conf.toml y directorio _build. El flujo de autoría está en docs/gds/workflow.rst.
Antes de publicar¶
Comprueba enlaces, diagnósticos, tablas anchas y bloques de código. Tras cambiar la tipografía, renderiza las páginas PDF. Prueba el HTML a anchos de escritorio y móvil, en claro y oscuro. Verifica que ecuaciones y diagramas funcionen sin red. Si cambias el motor, ejecuta las pruebas pertinentes de biblioteca e integración.