| commit | 26f0ff877bc20dceb21d090972846e30947f1cc3 | [log] [tgz] |
|---|---|---|
| author | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Thu Nov 21 23:22:41 2013 +0000 |
| committer | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Thu Nov 21 23:22:41 2013 +0000 |
| tree | c8a3d5c9732d5c1c894f747ff0459a223bfac94c | |
| parent | eee8c25b81f4505372bb872b4721f4d47a4eef96 [diff] |
Add README file git-svn-id: svn+ssh://dyadis.cs.arizona.edu/NDN-spec/spec-sphinx@92 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
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
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.