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