Sphinx como herramienta para documentar proyectos técnicos

• Autores: Javier García Tobar
• Localización: Técnica industrial, ISSN 0040-1838, Nº 315, 2016, págs. 48-52
• Idioma: español
• Títulos paralelos:
  • Sphinx as a tool of documenting technical projects
• Texto completo no disponible (Saber más ...)
• Resumen

  • La documentación es una tarea importante de un proyecto técnico que puede consumir bastante tiempo. Por esta razón, algunas veces se pasa por alto. Un sistema de documentación de éxito beneficiará a las organizaciones e individuos involucrados directamente. El presente artículo se centrará en resumir las principales características de Sphinx, una herramienta de código abierto creada para generar documentación de Python. La información se formateará adecuadamente en archivos estándar (HTML, PDF y ePub).

    Basado en esos resultados, este trabajo recomienda Sphinx para escribir eficientemente la documentación técnica de un proyecto. Esta herramienta cumple con los posibles requisitos que necesitará la documentación de un proyecto.