stringtranslate.com

Sphinx (generador de documentación)

Sphinx es un generador de documentación escrito y utilizado por la comunidad 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 explota su naturaleza extensible a través de 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.

Temas HTML

Sphinx ofrece la posibilidad de aplicar temas a HTML y formatos basados ​​en HTML. Sphinx tiene varios temas integrados, entre los que se incluyen Alabaster, Classic, Sphinxdoc y Scrolls. [2] Los temas populares que se pueden instalar como módulos de Python incluyen: [3]

Historia y uso

La primera versión pública, la 0.1.61611, se anunció el 21 de marzo de 2008. [8] Fue desarrollada para el proyecto Python y es ampliamente utilizada por él para documentación. [9]

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 [10] y la documentación de la API de Python. [11]

En 2010, Eric Holscher anunció [12] la creación del proyecto Read the Docs como parte de un esfuerzo por facilitar el mantenimiento de la documentación de software. Read the Docs automatiza el proceso de creación y carga de la documentación de Sphinx después de cada envío .

Núcleo de Linux

El subsistema de documentación del núcleo Linux sufrió cambios en 2016. A partir del ciclo 4.7, la documentación comenzó a cambiar para utilizar Sphinx. [13]

Véase también

Referencias

  1. ^ "Cambios en la Esfinge". Esfinge .
  2. ^ "Temas HTML". Documentación de Sphinx . Georg Brandl y el equipo de Sphinx . Consultado el 25 de junio de 2022 .
  3. ^ "Temas de Sphinx". Escribe los documentos . Consultado el 25 de junio de 2022 .
  4. ^ "Lee la documentación del tema Sphinx". repositorio de código de sphinx-rtd-theme . GitHub . Consultado el 25 de junio de 2022 .
  5. ^ "Tema Sphinx Bootstrap". Repositorio de código de sphinx_bootstrap_theme . GitHub . Consultado el 25 de junio de 2022 .
  6. ^ "Tema Guzzle Sphinx". Repositorio de código de guzzle_sphinx_theme . GitHub . Consultado el 25 de junio de 2022 .
  7. ^ "Colección de temas de Documatt Sphinx". Documatt.com . Consultado el 25 de junio de 2022 .
  8. ^ "¡Sphinx ha sido liberado! » Y ahora algo completamente Pythonic..." Y ahora algo completamente Pythonic... Georg Brandl. Archivado desde el original el 22 de marzo de 2012. Consultado el 3 de abril de 2011 .
  9. ^ "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 .
  10. ^ "Manual del usuario de Blender". Blender Wiki . Blender Foundation.
  11. ^ "Dev:2.5/Py/API/Generación de referencia de API - BlenderWiki!". Blender Foundation . Blender Foundation.
  12. ^ "Anuncio de Read The Docs". Noticias de Python Software Foundation . Eric Holscher . Consultado el 15 de febrero de 2015 .
  13. ^ "Actualización de la documentación del kernel". LWN.net . 2 de noviembre de 2016.

Enlaces externos