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