| Alexander Afanasyev | 2d600f7 | 2013-11-21 18:20:37 -0800 | [diff] [blame] | 1 | Prerequisites |
| 2 | ============= |
| 3 | |
| 4 | To "compile" documentation into html form you would need to install Sphinx documentation package, which should be relatively trivial. |
| 5 | |
| 6 | If you're on OSX platform: |
| 7 | |
| 8 | - If you have macports, then |
| 9 | |
| 10 | sudo port install py27-sphinx |
| 11 | sudo port selectsphinx py27-sphinx |
| 12 | |
| 13 | - Install from source: http://sphinx-doc.org/install.html |
| 14 | |
| 15 | - Install from .pkg binary package: http://named-data.net/binaries/sphinx-doc-0.2.pkg |
| 16 | |
| 17 | If you're on Ubuntu Linux: |
| 18 | |
| 19 | sudo apt-get install python-sphinx |
| 20 | |
| 21 | Compilation |
| 22 | =========== |
| 23 | |
| 24 | Just type |
| 25 | |
| 26 | make html |
| 27 | |
| 28 | And a set of HTML pages will be build under ``_build/html`` |
| 29 | |
| 30 | |
| 31 | You can also type |
| 32 | |
| 33 | make latexpdf |
| 34 | |
| 35 | This way Sphinx will prepare .tex file and will try to build .pdf document. |
| 36 | |