commit | ff8eef557822c620f2124a94209268145e30f8c5 | [log] [tgz] |
---|---|---|
author | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Wed Feb 12 19:53:47 2014 +0000 |
committer | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Wed Feb 12 19:53:47 2014 +0000 |
tree | e5a49086acc3bdd871c1fdbb69ff74dfdbbf1b05 | |
parent | 16962fc827fa9174da50f14d09aaeb173f4e3955 [diff] |
Removing hacky face-registration from index git-svn-id: svn+ssh://dyadis.cs.arizona.edu/NDN-spec/spec-sphinx@196 c5937c81-b952-4fd9-96ba-3036b240b622
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 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.