commit | 13f86d816adede826e1955819149d59e12f975d8 | [log] [tgz] |
---|---|---|
author | Alexander Afanasyev <aa@cs.fiu.edu> | Wed Jan 31 12:50:34 2018 -0500 |
committer | Alexander Afanasyev <aa@cs.fiu.edu> | Wed Jan 31 12:50:34 2018 -0500 |
tree | bef262a6ae3e80ee6e48709d66fd7e6b4125e592 | |
parent | b211da24857041a75d55021942d627f3d89556a6 [diff] |
Formally release version 0.2.1 of the spec Change-Id: Ia1bce45d7699a13ac299b38f3bd8fd94f0558e4f
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.