El proyecto usa la herramienta Sphinx para la generación de documentación. Esta documentación se escribe con el formato de texto reStructuredText.
Sphinx es una herramienta basada en Python, para la instalación del proyecto y todos sus requerimientos se incluye un archivo de requerimientos:
$ pip install -f requirements.pipPara instalar Sphinx se recomienda seguir las instrucciones en la documentación oficial.
Para agregar o modificar contenido, deben editarse los documentos *.rst que se encuentran dentro de la estructura de directorios disponible en source.
Para leer la documentación, es necesario compilar los documentos, esto se hace automáticamente cada vez que se actualiza la rama master de este repositorio, y la documentación estará disponible en Read The Docs.
Para generar formatos adicionales, o tener una copia local de la documentación, se utiliza el siguiente comando.
$ make htmlNOTA: html puede ser cambiado por pdf, laTex, o cualquiera de los formatos disponibles. Para conocer la lista de parámetros, basta con hacer la llamada a make sin parámetros.