Mercurial > public > sccdocs / file revision

Quick start
===========
* Install Python 2.7
* Install setup tools : http://pypi.python.org/pypi/setuptools
* Install sphinx by running::

   easy_install Sphinx

* Go into the documentation directory and run::

   make html

to generate an html version of the documentation or

   make latexpdf

to generate a PDF document.

Resources
=========

Sphinx main page:

http://sphinx.pocoo.org

Tutorial:

http://sphinx.pocoo.org/tutorial.html

Restructured text:

http://sphinx.pocoo.org/rest.html

Customising sphinx tutorial:

http://matplotlib.sourceforge.net/sampledoc/