| commit | 7feb49ca8f0931f6c091d79b1c957384368d5077 | [log] [tgz] |
|---|---|---|
| author | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Fri Mar 14 17:06:58 2014 -0700 |
| committer | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Sun Jun 08 11:12:55 2014 +0300 |
| tree | 4d0f7cf2f46b83608ac3b1684971b66448e4c0ff | |
| parent | 1ac334640da059791ad5c75637eee075fd0b87b3 [diff] |
Small spec corrections and fixing typos
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.