La habilidad de Referencias Cruzadas de Sphinx proporciona enlaces claros y fáciles de mantener entre páginas de documentación, objetos de referencia de la…
La habilidad de Referencias Cruzadas de Sphinx proporciona enlaces claros y fáciles de mantener entre páginas de documentación, objetos de referencia de la API y proyectos externos. Admite roles de Sphinx/reStructuredText y MyST como:ref:/:doc: para anclas de páginas y roles de dominio como:py:class:,:py:func: para objetos de la API de Python, ejemplificados por {ref}installation y {py:class}mypackage.core.DataProcessor. Úsela para crear tutoriales, guías de usuario y documentación de API generada automáticamente que se mantenga sincronizada a medida que cambian el código y las páginas. Las características clave incluyen creación de etiquetas/anclas, resolución específica por dominio, vinculación a proyectos externos mediante intersphinx y manejo de ambigüedades configurable. Las ventajas principales son enlaces robustos y semánticamente precisos en HTML, PDF y otros formatos de salida, menor mantenimiento por enlaces rotos y mejor descubribilidad de las clases, funciones y guías referenciadas. Ideal al redactar documentación para desarrolladores o al integrar referencias de API con documentación narrativa.
Esta página forma parte del hub OpenClaw Skills con guías de instalación, categorías y enlaces prácticos.