Repolode
Enviar
sphinx-doc

sphinx-doc/sphinx

Generador de documentación para Python que crea HTML, PDF, EPUB y otros formatos a partir de fuentes reStructuredText o Markdown.

Ver en GitHubSitio web
Estrellas
8,072
Forks
2,610
Issues abiertos
1,453
Último commit
hace 7 horas

¿Qué es?

Sphinx es un generador de documentación que convierte archivos fuente reStructuredText en documentación de calidad. Permite generar HTML, PDF, texto sin formato, EPUB, TeX y páginas de manual, y se basa en Docutils para analizar y traducir el contenido.

La herramienta se centra en las referencias cruzadas y la estructura de los documentos. Es posible enlazar semánticamente funciones, clases, términos de glosario y otros objetos, y los documentos forman un árbol con enlaces automáticos entre páginas hermanas, padres e hijas. También genera automáticamente índices generales y de módulos.

Sphinx destaca el código mediante Pygments y genera HTML con el motor de plantillas Jinja 2. Su ecosistema de extensiones añade funciones como la documentación automática de funciones, la compatibilidad con notebooks de Jupyter y dominios de lenguaje para Python, C, C++, JavaScript y matemáticas.

Funciones clave

  • 01Genera HTML, PDF, texto sin formato, EPUB, TeX y páginas de manual
  • 02Ofrece referencias cruzadas semánticas para funciones, clases y términos de glosario
  • 03Crea árboles de documentos con enlaces automáticos entre páginas relacionadas
  • 04Genera automáticamente índices generales y de módulos
  • 05Destaca el código con Pygments y genera HTML mediante plantillas Jinja 2
  • 06Se amplía mediante un ecosistema de plugins que incluye compatibilidad con los lenguajes Python, C, C++ y JavaScript

Casos de uso

  • Publicar documentación de referencia de API para una biblioteca de Python
  • Redactar manuales técnicos que necesiten generar PDF y HTML a partir de una única fuente
  • Mantener documentación de proyectos multilingüe o con versiones y referencias cruzadas

Inicio rápido

  1. 1

    Instala Sphinx desde PyPI con pip

    pip install -U sphinx

Antes de usarlo

  • El README no indica un nombre de licencia claro; los metadatos la muestran como NOASSERTION, aunque la insignia indica BSD 2-Clause.

Temas

#documentation#restructuredtext#python#docs-generator#html#pdf#docs#documentation-tool#markdown#sphinx

Preguntas frecuentes

¿Qué es sphinx?
Generador de documentación para Python que crea HTML, PDF, EPUB y otros formatos a partir de fuentes reStructuredText o Markdown. Sphinx es un generador de documentación que convierte archivos fuente reStructuredText en documentación de calidad. Permite generar HTML, PDF, texto sin formato, EPUB, TeX y páginas de manual, y se basa en Docutils para analizar y traducir el contenido.
¿sphinx es gratuito? ¿Qué licencia tiene?
sphinx es open source bajo la licencia Other. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿sphinx sigue mantenido?
Mantenimiento activo. El último commit de sphinx fue el 22 oct 2026.
¿Para qué puedo usar sphinx?
Publicar documentación de referencia de API para una biblioteca de Python Redactar manuales técnicos que necesiten generar PDF y HTML a partir de una única fuente Mantener documentación de proyectos multilingüe o con versiones y referencias cruzadas
¿Cómo se instala sphinx?
Instala Sphinx desde PyPI con pip: pip install -U sphinx
¿Dónde consigo sphinx?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/sphinx-doc/sphinx

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados