| commit | 948affed961ef9587101e4a8bff95f3768209072 | [log] [tgz] |
|---|---|---|
| author | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Tue Sep 13 13:15:29 2016 -0700 |
| committer | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Wed Sep 14 12:59:33 2016 -0700 |
| tree | d9b2cdc107a9ac4a90f97f37eaf0b260f1512f20 | |
| parent | 9c0dbbd523790350d3a11e454b7ad6146aad0568 [diff] |
Spec 0.2 Change-Id: I222b5f0636d759a9c8025e05e0175670679352ec
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.