diff -r c769ef87d110 -r f6927689a3b2 readme.md --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/readme.md Fri May 11 13:22:25 2012 +0200 @@ -0,0 +1,34 @@ +== 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/ +