Hispanopedia WikiSphinx es un generador de documentación escrito y utilizado por la comunidad de Python. Está escrito en Python y también se utiliza en otros entornos.
Propósito y función
Sphinx convierte archivos reStructuredText en sitios web HTML y otros formatos, incluidos PDF , EPub , Texinfo y man .
reStructuredText es extensible, y Sphinx aprovecha su naturaleza extensible mediante una serie de extensiones, para generar automáticamente documentación a partir del código fuente, escribir notación matemática o resaltar el código fuente, etc.
También es posible utilizar archivos Markdown gracias a extensiones como MyST Parser. [ 3 ]
temas HTML
Sphinx ofrece la posibilidad de aplicar temas a HTML y formatos basados en HTML. Sphinx cuenta con varios temas integrados, entre ellos alabaster, classic, sphinxdoc y scrolls. [ 4 ] Algunos temas populares que se pueden instalar como módulos de Python son: [ 5 ]
Historia y uso
La primera versión pública, la 0.1.61611, se anunció el 21 de marzo de 2008. [ 10 ] Fue desarrollada para el proyecto Python y es ampliamente utilizada por este para la documentación. [ 11 ]
Desde su introducción en 2008, Sphinx ha sido adoptado por muchos otros proyectos importantes de Python, incluidos Bazaar , SQLAlchemy , MayaVi , SageMath , SciPy , Django y Pylons . También se utiliza para el manual de usuario de Blender [ 12 ] y la documentación de la API de Python. [ 13 ]
En 2010, Eric Holscher anunció [ 14 ] la creación del proyecto Read the Docs como parte de un esfuerzo para facilitar el mantenimiento de la documentación del software. Read the Docs automatiza el proceso de compilación y carga de la documentación de Sphinx después de cada confirmación .
núcleo de Linux
El subsistema de documentación del kernel de Linux sufrió cambios en 2016. A partir del ciclo 4.7, la documentación comenzó a migrar al uso de Sphinx. [ 15 ]
Véase también
Referencias
- ↑ "Sphinx 8.2.3 (Python Package Index)" . Índice de paquetes de Python . Consultado el 23 de junio de 2025 .
- ↑ "Versión 9.1.0" . 31 de diciembre de 2025. Consultado el 4 de abril de 2026 .
- ↑ "MyST - Texto Marcadamente Estructurado - Documentación del Analizador" . Consultado el 24 de marzo de 2026 .
- ↑ "Temas HTML" . Documentación de Sphinx . Georg Brandl y el equipo de Sphinx . Consultado el 25 de junio de 2022 .
- ↑ "Temas de Sphinx" . Write the Docs . Consultado el 25 de junio de 2022 .
- ↑ "Tema Sphinx de Read the Docs" . Repositorio de código sphinx-rtd-theme . GitHub . Consultado el 25 de junio de 2022 .
- ↑ "Tema Sphinx Bootstrap" . Repositorio de código de sphinx_bootstrap_theme . GitHub . Consultado el 25/06/2022 .
- ↑ "Guzzle Sphinx Theme" . Repositorio de código de guzzle_sphinx_theme . GitHub . Consultado el 25/06/2022 .
- ↑ "Colección de temas Documatt Sphinx" . Documatt.com . Consultado el 25 de junio de 2022 .
- ↑ "¡Sphinx ha sido liberado! » Y ahora algo completamente Python..." Y ahora algo completamente Python... Georg Brandl. Archivado del original el 22 de marzo de 2012. Recuperado el 3 de abril de 2011 .
- ↑ "Acerca de estos documentos — Documentación de Python v2.7.1" . Documentación de Python . Python Software Foundation . Consultado el 3 de abril de 2011 .
- ↑ "Manual de usuario de Blender" . Wiki de Blender . Fundación Blender.
- ↑ "Dev:2.5/Py/API/Generating API Reference - BlenderWiki!" . Blender Foundation .
- ↑ "Anuncio de Read The Docs" . Noticias de la Python Software Foundation . Eric Holscher . Consultado el 15 de febrero de 2015 .
- ↑ "Actualización de la documentación del kernel" . LWN.net . 2 de noviembre de 2016.
Enlaces externos
- Sitio web oficial
- Read the Docs , un servidor de documentación colaborativo a gran escala impulsado por Sphinx.
- Generadores de documentación gratuitos
- Software libre programado en Python
- Software que utiliza la licencia BSD.