| commit | 1f53de431be14feae773bcdc01c08175c3e07ff5 | [log] [tgz] |
|---|---|---|
| author | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Sun Dec 01 19:25:55 2013 +0000 |
| committer | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Sun Dec 01 19:25:55 2013 +0000 |
| tree | 097481a140344bbb1d0a2c7ab815a81e0946f3e2 | |
| parent | e280023fbde6633c094ab9547a12670d3f8bed67 [diff] |
Updated readme (instruction how to install sphinx extensions) git-svn-id: svn+ssh://dyadis.cs.arizona.edu/NDN-spec/spec-sphinx@95 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.