Fri, 11 May 2012 13:27:13 +0200
Changed markdown to Restructured text.
readme.rst | file | annotate | diff | comparison | revisions |
--- a/readme.rst Fri May 11 13:25:05 2012 +0200 +++ b/readme.rst Fri May 11 13:27:13 2012 +0200 @@ -1,34 +1,37 @@ -== Quick start == +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 -}}} +* 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 -{{{ -#!python -make latexpdf -}}} + + make latexpdf + to generate a PDF document. -== Resources == +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/