| commit | bdc7501a301a4b7fc71dd61697786f3ce3918091 | [log] [tgz] |
|---|---|---|
| author | Junxiao Shi <git@mail1.yoursunny.com> | Tue Jan 13 22:09:12 2015 -0700 |
| committer | Junxiao Shi <git@mail1.yoursunny.com> | Wed Jan 21 23:23:43 2015 -0700 |
| tree | 4069c4469d460df4fc46943c817e8b6098ab0f25 | |
| parent | 99b8a848b379f5f08df5a94ef46a79294ec1d31b [diff] |
interest: delete deprecated Scope refs #1734 Change-Id: I839c70006062068a79366c30c38483f892cbb08d
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.