| Alexander Afanasyev | 26f0ff8 | 2013-11-21 23:22:41 +0000 | [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 | |
| Alexander Afanasyev | 1f53de4 | 2013-12-01 19:25:55 +0000 | [diff] [blame^] | 13 | sudo easy_install-2.7 sphinxcontrib-fulltoc |
| 14 | sudo easy_install-2.7 sphinxcontrib-bibtex |
| 15 | |
| Alexander Afanasyev | 26f0ff8 | 2013-11-21 23:22:41 +0000 | [diff] [blame] | 16 | - Install from source: http://sphinx-doc.org/install.html |
| 17 | |
| 18 | - Install from .pkg binary package: http://named-data.net/binaries/sphinx-doc-0.2.pkg |
| 19 | |
| 20 | If you're on Ubuntu Linux: |
| 21 | |
| 22 | sudo apt-get install python-sphinx |
| 23 | |
| Alexander Afanasyev | 1f53de4 | 2013-12-01 19:25:55 +0000 | [diff] [blame^] | 24 | sudo easy_install sphinxcontrib-fulltoc |
| 25 | sudo easy_install sphinxcontrib-bibtex |
| 26 | |
| Alexander Afanasyev | 26f0ff8 | 2013-11-21 23:22:41 +0000 | [diff] [blame] | 27 | Compilation |
| 28 | =========== |
| 29 | |
| 30 | Just type |
| 31 | |
| 32 | make html |
| 33 | |
| 34 | And a set of HTML pages will be build under ``_build/html`` |
| 35 | |
| 36 | |
| 37 | You can also type |
| 38 | |
| 39 | make latexpdf |
| 40 | |
| 41 | This way Sphinx will prepare .tex file and will try to build .pdf document. |
| 42 | |