| commit | 7455e9b68fb6bd43283ab5bc526c1fcb68e4a0aa | [log] [tgz] |
|---|---|---|
| author | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Wed Jun 25 09:41:08 2014 -0700 |
| committer | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Tue Jul 01 12:13:31 2014 -0700 |
| tree | a9f75d6db5a9183f235d57512ac94972fefbd789 | |
| parent | 4b89611d05e6a97394af54e6e458b047f19d2b2f [diff] |
Small fixes and clarifications Change-Id: Ieb5669d21b9bb53c4c749271f25792e394130b26
To "compile" documentation into html form you would need to install Sphinx documentation package, which should be relatively trivial.
If you're on OSX platform:
If you have macports, then
sudo port install py27-sphinx sudo port selectsphinx py27-sphinx
sudo easy_install-2.7 sphinxcontrib-fulltoc sudo easy_install-2.7 sphinxcontrib-bibtex
Install from source: http://sphinx-doc.org/install.html
Install from .pkg binary package: http://named-data.net/binaries/sphinx-doc-0.2.pkg
If you're on Ubuntu Linux:
sudo apt-get install python-sphinx python-setuptools sudo easy_install sphinxcontrib-fulltoc sudo easy_install sphinxcontrib-bibtex
Just type
make html
And a set of HTML pages will be build under _build/html
You can also type
make latexpdf
This way Sphinx will prepare .tex file and will try to build .pdf document.