documentación pitón Sphinx [cerrado]

Question

Puede alguien decirme cómo se puede utilizar este proyecto a modo de documentación http://sphinx.pocoo.org

He instalado con éxito en mis CentOS instalación .Después de la máquina El archivo Léame dice a ejecutar esfinge de inicio rápido y la raíz de la documentación es / home / tom / Docs

Cuando a partir de aquí ¿Cómo puedo usar los comandos en / home / tom / Docs Tengo archivos   __build   conf.py   index.rst   make.bat   Makefile   _static   _templates

Lo que sigue? Cómo generar informes para mi proyecto Django que reside en / usr / mi in situ

Answer 1

Bueno, vas a tener que leer un poco a ti mismo. Sin embargo, como una visión general básica:

• Por lo general, correría esfinge de inicio rápido en una subcarpeta de su proyecto para la documentación (por ejemplo /usr/my-site/docs).
• Usted escribe la documentación Esfinge en formato reStructuredText (RST). Empezar editando el archivo index.rst, y se puede añadir más archivos más tarde.
• Cuando haya terminado, el uso make html (o make.bat html en Windows) para crear los archivos HTML de su RST.