Migrar un proyecto de Sphinx¶
Guidedog sigue la estructura de proyecto de Sphinx y muchos nombres de opciones. No ejecuta conf.py ni extensiones Python. La migración empieza separando datos de configuración ejecutable.
guidedog migrate path/to/conf.py
guidedog build html path/to/docs --diagnostics=json
migrate lee valores literales y escribe conf.toml. Informa de los valores calculados que requieren una decisión humana. No importa el proyecto ni ejecuta Python para averiguarlos. Revisa el resultado antes de considerarlo equivalente.
Trabajar en tres etapas¶
- Corrija el grafo documental. Compruebe la raíz, los sufijos, las exclusiones y los includes.
- Corrija las referencias. Compruebe dominios, inventarios y tipos de objetos personalizados.
- Corrija la presentación. Compruebe plantillas, diagramas, matemáticas y ambos formatos.
Una directiva desconocida puede pertenecer a una extensión privada. Un HTML construido con éxito no demuestra que se hayan reproducido sus reglas. Lee los diagnósticos y decide si sustituirla, configurar un alias compatible o mantener una limitación documentada.
Consulta Compatibilidad con Sphinx para la compatibilidad y las pruebas con CPython, Django y Flask; Declarar tipos de objetos para objetos personalizados declarativos.