commit | 9e0791a22bbac60aafe88ecedd402047d1e3aa5d | [log] [tgz] |
---|---|---|
author | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Fri Jun 12 19:00:31 2015 -0700 |
committer | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Fri Jun 12 19:00:31 2015 -0700 |
tree | d78c8fa81fa213ccfad26d7919d2e4cfc35023e7 | |
parent | 4406fdd1c12a0bd5190ac562a3402e1fbe217b35 [diff] |
Fix typo in signature definition Change-Id: I7006d696f1e7ed2d8492190388e50166a3aaaf20 Refs: #2897
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.