commit | e9f48510fe62589334309641a378e591317b8b33 | [log] [tgz] |
---|---|---|
author | Alexander Afanasyev <aa@cs.fiu.edu> | Mon Jan 15 23:44:50 2018 -0500 |
committer | Alexander Afanasyev <aa@cs.fiu.edu> | Thu Feb 15 08:25:06 2018 -0500 |
tree | dd48a6a2c0083222c1e79c7954b2a4e0b4a37fcd | |
parent | 13f86d816adede826e1955819149d59e12f975d8 [diff] |
Updates for version 0.3 Change-Id: I1e5307e5c04323046549c001fcf638c17e08f0ab Refs: #4445, #4444, #4443, #4442, #4441, #4440, #4485
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.