readme.rst@a6e69feda10d (annotated)
readme.rst
Thu, 17 Mar 2016 12:07:31 +0200
- author
- Ioannis <binietoglou@noa.gr>
- date
- Thu, 17 Mar 2016 12:07:31 +0200
- changeset 65
- a6e69feda10d
- parent 12
- 3171dc8d75e7
- permissions
- -rw-r--r--
Typos and small changes to HOI page.
| binietoglou@12 | 1 | Quick start |
| binietoglou@12 | 2 | =========== |
| binietoglou@9 | 3 | * Install Python 2.7 |
| binietoglou@9 | 4 | * Install setup tools : http://pypi.python.org/pypi/setuptools |
| binietoglou@12 | 5 | * Install sphinx by running:: |
| binietoglou@12 | 6 | |
| binietoglou@12 | 7 | easy_install Sphinx |
| binietoglou@12 | 8 | |
| binietoglou@12 | 9 | * Go into the documentation directory and run:: |
| binietoglou@12 | 10 | |
| binietoglou@12 | 11 | make html |
| binietoglou@12 | 12 | |
| binietoglou@9 | 13 | to generate an html version of the documentation or |
| binietoglou@12 | 14 | |
| binietoglou@12 | 15 | make latexpdf |
| binietoglou@12 | 16 | |
| binietoglou@9 | 17 | to generate a PDF document. |
| binietoglou@9 | 18 | |
| binietoglou@12 | 19 | Resources |
| binietoglou@12 | 20 | ========= |
| binietoglou@9 | 21 | |
| binietoglou@9 | 22 | Sphinx main page: |
| binietoglou@12 | 23 | |
| binietoglou@9 | 24 | http://sphinx.pocoo.org |
| binietoglou@9 | 25 | |
| binietoglou@9 | 26 | Tutorial: |
| binietoglou@12 | 27 | |
| binietoglou@9 | 28 | http://sphinx.pocoo.org/tutorial.html |
| binietoglou@9 | 29 | |
| binietoglou@9 | 30 | Restructured text: |
| binietoglou@12 | 31 | |
| binietoglou@9 | 32 | http://sphinx.pocoo.org/rest.html |
| binietoglou@9 | 33 | |
| binietoglou@9 | 34 | Customising sphinx tutorial: |
| binietoglou@12 | 35 | |
| binietoglou@9 | 36 | http://matplotlib.sourceforge.net/sampledoc/ |
| binietoglou@9 | 37 |
