| commit | b211da24857041a75d55021942d627f3d89556a6 | [log] [tgz] |
|---|---|---|
| author | Junxiao Shi <git@mail1.yoursunny.com> | Thu Dec 14 20:05:35 2017 +0000 |
| committer | Junxiao Shi <git@mail1.yoursunny.com> | Thu Dec 14 20:05:35 2017 +0000 |
| tree | 4916f2170c380451f34add49828fab87f6412e8f | |
| parent | 1082b4291caaa3ea772dd2649a311cf44eaaa0cd [diff] |
types: add Link object related assignments Also, NameComponent is renamed to GenericNameComponent to match "NDN Name Format" section. refs #4054, #2011 Change-Id: I276189a29fb0dfc49593a0eb445894594ac57739
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.