| commit | 247078624f6c65a2321ce6432993fa01d12421d7 | [log] [tgz] |
|---|---|---|
| author | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Tue Nov 26 19:31:45 2013 -0800 |
| committer | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Tue Nov 26 19:31:45 2013 -0800 |
| tree | f020b34d2eb8d434080cd1eeae79fe0eb6f5ec6c | |
| parent | 57e20eda04aff7a6d09667becd86a6000f778d7a [diff] |
Removing references to WireFormat from API docs This change does require any changes of actual implementation. Specific language documentation (e.g., doxygen for C++) will include all necessary specific wire format related parameters and classes. Change-Id: I51bfdc4a01b6b0de54c88f655f2c9091d1bb35e2
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.