| commit | de1063bac1a90adba7d9ea4eb19fc57442d01079 | [log] [tgz] |
|---|---|---|
| author | Alexander Afanasyev <aa@cs.fiu.edu> | Fri Mar 02 18:51:43 2018 -0500 |
| committer | Alexander Afanasyev <aa@cs.fiu.edu> | Fri Mar 02 18:51:43 2018 -0500 |
| tree | 73398b346b4c4c77d122616f7ccac983386153a5 | |
| parent | e9f48510fe62589334309641a378e591317b8b33 [diff] |
Add disclaimer about the new changes and add link to the old version Change-Id: Ib75ea5c6560fa874b3eb3f605ca114a9d2202fcb
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.