commit | 1ac334640da059791ad5c75637eee075fd0b87b3 | [log] [tgz] |
---|---|---|
author | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Fri Mar 14 15:27:07 2014 -0700 |
committer | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Sun Jun 08 11:12:23 2014 +0300 |
tree | 836db99ba8687c48775cf84e7322ff2c53491238 | |
parent | 899585e779dcca320990fd97fb56ef4feb1ce6f0 [diff] |
Introducing explicit types for Number and Digest components
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.