commit | 1082b4291caaa3ea772dd2649a311cf44eaaa0cd | [log] [tgz] |
---|---|---|
author | Junxiao Shi <git@mail1.yoursunny.com> | Tue Jul 18 23:37:52 2017 +0000 |
committer | Junxiao Shi <git@mail1.yoursunny.com> | Tue Jul 18 23:37:52 2017 +0000 |
tree | b9964479e2282c8fa92ab52e04ee2525d98973a9 | |
parent | cfc5d216948b5fe607c432cc3ee77b008e33292c [diff] |
types+tlv: distinguish "value" and "number" The word "value" is used only when referring to TLV-VALUE. Otherwise, the word "number" is used instead. refs #2880 Change-Id: Ifaa850dea02fae3cc704ecc1c31345c0326eb26a
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.