Documentar una base de código¶
Un nombre público necesita un contrato: entrada, resultado, propiedad y condiciones de fallo. Una firma por sí sola no es un manual.
Odin¶
odin_autoapi_dirs = ["../../lib"]
odin_autoapi_root = "api"
odin_autoapi_options = ["members", "undoc-members"]
Guidedog lee el código Odin con su parser, sin compilar ni ejecutar el paquete documentado. Las páginas generadas se incorporan al grafo y al inventario de objetos. El proyecto API independiente del repositorio es docs/api. Consulta Documentar Odin para las directivas, firmas y opciones.
Python¶
extensions = ["sphinx.ext.autodoc"]
autodoc_source_paths = ["../src"]
Guidedog analiza el código Python sin importarlo, evitando los efectos secundarios de la importación. Puede omitir objetos creados en ejecución. Descríbelos explícitamente si forman parte de la interfaz pública. Las reglas exactas están en Documentar Python con autodoc.
Enlazar proyectos¶
Publica el objects.inv generado junto con el sitio. Otro proyecto podrá resolver nombres mediante intersphinx. Usa mapas explícitos para construcciones reproducibles. Consulta Enlazar con otros proyectos.