Sphinx (generador de documentación)
Sphinx es un software generador de documentación que convierte ficheros reStructuredText en sitios web HTML y otros formatos, incluyendo PDF, EPub y man. Saca provecho de la naturaleza extensible de reStructuredText y sus extensiones (ej. para generar automáticamente documentación desde código fuente, escribir notación matemática o resalzar código). El primer lanzamiento público, la versión 0.1.61611, se hizo el 21 de marzo de 2008.[1] Se desarrolló y usó extensivamente por y para el Proyecto de documentación Python.[2] El logotipo de la herramienta se inspira en el símbolo egipcio del ojo de Horus, Udyat[3]
| Sphinx | ||
|---|---|---|
| Información general | ||
| Tipo de programa | Generador de documentación | |
| Desarrollador | Georg Brandl | |
| Lanzamiento inicial | 21 de marzo de 2008 | |
| Licencia | Licencia BSD | |
| Idiomas | inglés | |
| Información técnica | ||
| Programado en | Python | |
| Versiones | ||
| Última versión estable | 1.1.3 (info) ( 10 de marzo de 2012 (12 años, 1 mes y 15 días)) | |
| Archivos legibles | ||
| ReStructuredText | ||
| Enlaces | ||
Desde su introducción en 2008, Sphinx ha sido adoptado por muchos otros proyectos Python importantes, como Bazaar, SQLAlchemy, MayaVi, Sage, SciPy, Django y Pylons; también se usa para documentar la API Python de Blender.[4] Destaca entre ellos, la recopilación documental de todo el proyecto mozilla.org llamado Bedrock. El proyecto Read the Docs,[5] que automatiza el proceso de construir y subir documentación Sphinx después de cada commit, se creó para hacer más sencillo el mantenimiento de la documentación. Sphinx está patrocinado por la Python Software Foundation.[6]
Véase también editar
Referencias editar
- ↑ «Sphinx is released! » And now for something completely Pythonic...». And now for something completely Pythonic... Georg Brandl. Archivado desde el original el 22 de marzo de 2012. Consultado el 3 de abril de 2011.
- ↑ «About these documents — Python v2.7.1 documentation». Python documentation. Python Software Foundation. Consultado el 3 de abril de 2011.
- ↑ «Sphinx como herramienta para documentar proyectos técnicos». Revista Técnica Industrial. Revista Técnica Industrial. Consultado el 2 de marzo de 2017.
- ↑ «Dev:2.5/Py/API/Generating API Reference - BlenderWiki!». Blender Wiki. Blender Foundation. Archivado desde el original el 26 de enero de 2013. Consultado el 6 de abril de 2011.
- ↑ «Announcing Read The Docs». Surfing in Kansas. Eric Holscher. Consultado el 6 de abril de 2011.
- ↑ «Python Software Foundation News: PSF Funds readthedocs.org». Python Software Foundation News. Python Software Foundation. Consultado el 6 de abril de 2011.
Enlaces externos editar
- Sitio web oficial
- Lista de proyectos que usan Sphinx
- Documentación Python (generada usando Sphinx)
Datos: Q1633731
