Sphinx

Sphinx es un generador de documentación que transforma archivos fuente escritos en reStructuredText (reST) o Markdown en diversos formatos, como HTML, PDF, LaTeX, ePub, entre otros. Su enfoque modular y personalizable permite a los desarrolladores generar documentación automatizada que puede integrarse fácilmente en proyectos de software.

La herramienta destaca por su integración con docstrings (comentarios dentro del código), lo que facilita la extracción automática de información desde el propio código fuente. Esto la hace ideal para proyectos en Python, aunque también puede ser utilizada con otros lenguajes como C, C++, JavaScript, entre otros.

Contenidos

• Instalación
  • 1. Actualizar el sistema
  • 2. Instalar dependencias necesarias
  • 3. Instalar Sphinx
  • 4. Verificar la instalación
  • 5. Crear un nuevo proyecto de documentación
  • 6. Construir la documentación
  • 7. (Opcional) Instalar extensiones útiles
  • 8. Recursos adicionales
• Agregar imágenes y logo
  • 1. Agregar imágenes en Markdown
  • 2. Usar _static para imágenes globales
  • 3. Configuración en conf.py
  • 4. Enlaces a imágenes externas
  • 5. Agregar un logo al tema HTML (barra lateral)
  • 6. Solución de problemas