| commit | 988e74194a383587d1443e1ef0b6671802f535ba | [log] [tgz] |
|---|---|---|
| author | spirosmastorakis <spiros.mastorakis@gmail.com> | Thu Oct 27 14:01:59 2016 -0700 |
| committer | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Tue Nov 01 13:31:10 2016 -0700 |
| tree | 487c825f269ba9c8c18be750631ca67607141996 | |
| parent | 948affed961ef9587101e4a8bff95f3768209072 [diff] |
Adding documentation for link object Change-Id: Ied40e45296fb25b7efd227e2e13a2af48223ba1b
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.