| commit | a0d3682abc4e2ada03d5585252d46988957e1119 | [log] [tgz] |
|---|---|---|
| author | Junxiao Shi <git@mail1.yoursunny.com> | Sun Sep 21 11:32:09 2014 -0700 |
| committer | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Tue Sep 30 13:42:26 2014 -0700 |
| tree | a41ee12a80b692017835a177c8c841b45b5f7f9b | |
| parent | bff0e7091e87438fdd6265bb1df33bd1682ca18a [diff] |
name: permit zero-length NameComponent refs #1932 Change-Id: I788e4492ad09f13a5fec791d03293aa86b152189
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.