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.

binietoglou@9 1 == Quick start ==
binietoglou@9 2 * Install Python 2.7
binietoglou@9 3 * Install setup tools : http://pypi.python.org/pypi/setuptools
binietoglou@9 4 * Install sphinx by running
binietoglou@9 5 {{{
binietoglou@9 6 #!python
binietoglou@9 7 easy_install Sphinx
binietoglou@9 8 }}}
binietoglou@9 9 * Go into the documentation directory and run
binietoglou@9 10 {{{
binietoglou@9 11 #!python
binietoglou@9 12 make html
binietoglou@9 13 }}}
binietoglou@9 14 to generate an html version of the documentation or
binietoglou@9 15 {{{
binietoglou@9 16 #!python
binietoglou@9 17 make latexpdf
binietoglou@9 18 }}}
binietoglou@9 19 to generate a PDF document.
binietoglou@9 20
binietoglou@9 21 == Resources ==
binietoglou@9 22
binietoglou@9 23 Sphinx main page:
binietoglou@9 24 http://sphinx.pocoo.org
binietoglou@9 25
binietoglou@9 26 Tutorial:
binietoglou@9 27 http://sphinx.pocoo.org/tutorial.html
binietoglou@9 28
binietoglou@9 29 Restructured text:
binietoglou@9 30 http://sphinx.pocoo.org/rest.html
binietoglou@9 31
binietoglou@9 32 Customising sphinx tutorial:
binietoglou@9 33 http://matplotlib.sourceforge.net/sampledoc/
binietoglou@9 34

mercurial