python sphinx documentation [closed]

Question

Can any one tell me how can this project be used for documentation purpose http://sphinx.pocoo.org

I have successfully installed it on my CentOS machine .After installation The Readme file says to run sphinx-quickstart and root for documentation is /home/tom/Docs

Where to from here how can i use the commands in /home/tom/Docs i have files __build conf.py index.rst make.bat Makefile _static _templates

What next?how to generate reports for my django project which resides in /usr/my-site

Answer 1

Well, you're going to have to do some reading up yourself. However, as a basic overview:

• You would usually run sphinx-quickstart in a subfolder of your project for documentation (e.g. /usr/my-site/docs).
• You write Sphinx documentation in reStructuredText (rst) format. Start by editing the index.rst file, and you can add more files later.
• When you're done, use make html (or make.bat html on Windows) to build the HTML files from your RST.