Sphinx (generador de documentación)

La versión actual de la página aún no ha sido revisada por colaboradores experimentados y puede diferir significativamente de la versión revisada el 20 de agosto de 2020; las comprobaciones requieren 2 ediciones .
Esfinge
Tipo de Generador de documentación
Desarrollador Jorge Brandl
Escrito en Pitón
Sistema operativo software multiplataforma
Primera edición 21 de marzo de 2008 ( 2008-03-21 )
ultima versión

4.2.0

[1] (12 de septiembre de 2021 ) ( 2021-09-12 )
Formatos de archivo legibles Texto reestructurado
Licencia BSD
Sitio web esfinge-doc.org

Sphinx  es un generador de documentación que convierte archivos reStructuredText a sitios web HTML y otros formatos ( PDF , EPub y man ). Utiliza una serie de extensiones para reStructuredText (por ejemplo, para generar automáticamente la documentación del código fuente, generar fórmulas matemáticas o resaltar el código fuente). El primer lanzamiento público (versión 0.1.61611) se anunció el 21 de marzo de 2008. [2] Fue desarrollado y ampliamente utilizado para documentar el lenguaje de programación Python , así como sus módulos adicionales. [3]

Desde su inicio en 2008, Sphinx ha sido adoptado por muchos proyectos importantes de Python: Bazaar , SQLAlchemy , MayaVi , Sage , SciPy , Django y Pylons ; también se usa para documentar la API Python de Blender . [4] El proyecto Read the Docs fue creado para facilitar el soporte de la documentación del software . [5] Automatiza el proceso de creación y carga de la documentación de Sphinx después de cada confirmación del código fuente. El proyecto está patrocinado por la Python Software Foundation . [6]

Véase también

Enlaces

  1. ↑ Cambios en Esfinge . Consultado el 29 de enero de 2019. Archivado desde el original el 30 de enero de 2019.
  2. ↑ ¡Lanzamiento de Sphinx! » Y ahora algo completamente pitónico... . Y ahora algo completamente pitónico... . Jorge Brandl. Consultado el 3 de abril de 2011. Archivado desde el original el 26 de enero de 2013.
  3. ↑ Acerca de estos documentos: documentación de Python v2.7.1 . Documentación de Python . Fundación de software de Python. Consultado el 3 de abril de 2011. Archivado desde el original el 26 de enero de 2013.
  4. ↑ Dev:2.5/Py/API/Generación de referencia API - ¡BlenderWiki! (enlace no disponible) . Wiki de Blender . Fundación licuadora. Consultado el 6 de abril de 2011. Archivado desde el original el 26 de enero de 2013. 
  5. ↑ Anuncio de Read The Docs . Surfeando en Kansas . Eric Holscher. Consultado el 6 de abril de 2011. Archivado desde el original el 26 de enero de 2013.
  6. ↑ Noticias de Python Software Foundation: Fondos PSF readthedocs.org . Noticias de la Fundación de Software Python . Fundación de software de Python. Consultado el 6 de abril de 2011. Archivado desde el original el 26 de enero de 2013.

Literatura

 Pitón
Comunidad
Implementaciones
Otro