| commit | 72d973cfca9807f4874c686cb1acf5fa73b0e935 | [log] [tgz] |
|---|---|---|
| author | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Thu Nov 21 23:15:35 2013 -0800 |
| committer | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Thu Nov 21 23:20:55 2013 -0800 |
| tree | 005349f19161f480ffb491a151199bbb0c0f3444 | |
| parent | 112250175ac0fac93da8a5a8398c9a047d114ccf [diff] |
Suppressing TOC for library implementation details Change-Id: Iecac5b6f8de74b64c2501c70ad602c72c2cb8f3f
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
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
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.