Plugin de MkDocs que genera documentación de referencia de API directamente a partir de los docstrings del código fuente mediante handlers específicos para cada lenguaje.
2,1 mil+2 esta semana126PythonISCActualizado hace 15 días
breathe-doc/breathe
Un plugin de Sphinx que integra en la documentación de reStructuredText y Sphinx las API de C/C++ generadas con Doxygen.
- Estrellas
- 816
- Forks
- 215
- Issues abiertos
- 220
- Último commit
- hace 6 días
¿Qué es?
Breathe conecta Doxygen y Sphinx. Doxygen analiza el código fuente y extrae un modelo detallado de sus clases, funciones y otros símbolos, mientras que Sphinx genera documentación extensa y cuidada. Breathe lee la salida XML de Doxygen y la expone como directivas de Sphinx, para que las páginas de referencia de la API se puedan redactar y dar formato junto con el texto escrito manualmente en el mismo conjunto de documentación.
El plugin se instala desde PyPI con pip y requiere Python 3.9+, Sphinx 7.2+ y Doxygen 1.9.2+. La documentación incluye ejemplos de las directivas disponibles, y el repositorio cuenta con un conjunto de pruebas y un script para comparar la salida de la documentación entre commits.
El proyecto está mantenido por un pequeño grupo de colaboradores y lo usan varias bases de código grandes de código abierto, como PyTorch, NumPy y Apache Arrow, para publicar sus referencias de API de C y C++.
Funciones clave
- 01Genera directivas de Sphinx a partir de la salida XML de Doxygen para C, C++ y símbolos relacionados.
- 02Permite integrar las páginas de referencia de la API con contenido de reStructuredText escrito manualmente.
- 03Se instala desde PyPI con pip.
- 04Requiere Python 3.9+, Sphinx 7.2+ y Doxygen 1.9.2+.
- 05Incluye un conjunto de pruebas y un script para comparar la salida de la documentación entre commits.
Casos de uso
- Publicar la referencia de la API de una biblioteca de C o C++ junto con su guía de usuario en Sphinx.
- Mantener sincronizada la documentación de la API generada a partir de comentarios del código fuente con la documentación escrita manualmente.
- Documentar bases de código embebido o de sistemas que ya usan Doxygen.
Inicio rápido
- 1
Instala Breathe desde PyPI
pip install breathe
Antes de usarlo
- Es necesario instalar Doxygen 1.9.2 o posterior y Sphinx 7.2 o posterior por separado.
- La licencia no está especificada claramente en los metadatos.
En colecciones
Temas
Preguntas frecuentes
- ¿Qué es breathe?
- Un plugin de Sphinx que integra en la documentación de reStructuredText y Sphinx las API de C/C++ generadas con Doxygen. Breathe conecta Doxygen y Sphinx. Doxygen analiza el código fuente y extrae un modelo detallado de sus clases, funciones y otros símbolos, mientras que Sphinx genera documentación extensa y cuidada. Breathe lee la salida XML de Doxygen y la expone como directivas de Sphinx, para que las páginas de referencia de la API se puedan redactar y dar formato junto con el texto escrito manualmente en el mismo conjunto de documentación.
- ¿breathe es gratuito? ¿Qué licencia tiene?
- breathe es open source bajo la licencia Other. Revisa los términos de la licencia antes de usarlo en productos comerciales.
- ¿breathe sigue mantenido?
- Mantenimiento activo. El último commit de breathe fue el 1 nov 2026.
- ¿Para qué puedo usar breathe?
- Publicar la referencia de la API de una biblioteca de C o C++ junto con su guía de usuario en Sphinx. Mantener sincronizada la documentación de la API generada a partir de comentarios del código fuente con la documentación escrita manualmente. Documentar bases de código embebido o de sistemas que ya usan Doxygen.
- ¿Cómo se instala breathe?
- Instala Breathe desde PyPI: pip install breathe
- ¿Dónde consigo breathe?
- El código fuente y las instrucciones de instalación están en GitHub: https://github.com/breathe-doc/breathe
Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.
Proyectos relacionados
Doxygen genera documentación a partir de código fuente anotado y también puede crear diagramas de estructura y dependencias a partir de código sin documentar.
6,6 mil+4 esta semana1,4 milC++GPL-2.0Bien mantenidoActualizado hace 4 días
Generador de documentación para Python que crea HTML, PDF, EPUB y otros formatos a partir de fuentes reStructuredText o Markdown.
8,1 mil2,6 milPythonOtherActualizado hace 5 días
Herramienta de línea de comandos que observa un directorio de documentación de Sphinx, la reconstruye cuando hay cambios y recarga el navegador mediante un servidor local.
611100PythonMITActualizado hace 15 días
Una extensión de Sphinx que incorpora las anotaciones de tipos de Python a los campos de parámetros y valores de retorno de autodoc, con enlaces y compatibilidad con stubs.
588115PythonMITBien mantenidoActualizado hace 16 horas
Una extensión de Sphinx que analiza docstrings al estilo NumPy y los convierte en documentación de API estructurada.
354184PythonOtherActualizado hace 6 días