Sphinx como herramienta para documentar proyectos técnicos
2016
La documentacion es una tarea importante de un proyecto
tecnico que puede consumir bastante tiempo. Por
esta razon, algunas veces se pasa por alto. Un sistema de
documentacion de exito beneficiara a las organizaciones e
individuos involucrados directamente. El presente articulo se
centrara en resumir las principales caracteristicas de Sphinx,
una herramienta de codigo abierto creada para generar
documentacion de Python. La informacion se formateara
adecuadamente en archivos estandar (HTML, PDF y ePub).
Basado en esos resultados, este trabajo recomienda Sphinx
para escribir eficientemente la documentacion tecnica de un
proyecto. Esta herramienta cumple con los posibles requisitos
que necesitara la documentacion de un proyecto.
Keywords:
- Correction
- Source
- Cite
- Save
- Machine Reading By IdeaReader
0
References
0
Citations
NaN
KQI