readme.rst

Fri, 11 May 2012 13:25:05 +0200

author
ulalume3@yahoo.com
date
Fri, 11 May 2012 13:25:05 +0200
changeset 11
79fea4145278
parent 10
readme.md@f6927689a3b2
child 12
3171dc8d75e7
permissions
-rw-r--r--

Restructuring the repository.

== Quick start ==
* Install Python 2.7
* Install setup tools : http://pypi.python.org/pypi/setuptools
* Install sphinx by running
{{{
#!python
easy_install Sphinx
}}}
* Go into the documentation directory and run
{{{
#!python
make html
}}}
to generate an html version of the documentation or
{{{
#!python
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/

mercurial