commit | def7fc5f57f7290e62d394911f67e1ca78ac1e5a | [log] [tgz] |
---|---|---|
author | Junxiao Shi <git@mail1.yoursunny.com> | Wed Jun 10 13:29:21 2015 -0700 |
committer | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Wed Jun 10 16:35:46 2015 -0700 |
tree | 61915ab063f0b9e1e931e051946ff8791ac8f291 | |
parent | 333f2c21a9768dd0eb5e9ca79c3811bfd30b5487 [diff] |
interest: put 'delete Scope guider' into changelog refs #1734 Change-Id: I21c19992b19ac3edb8d42eede3cf9758032e88a5
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.