| commit | fd9d70849c223673d29d43c5b7ca9f6ea4f5c2d6 | [log] [tgz] |
|---|---|---|
| author | Varun Patil <varunpatil@ucla.edu> | Fri Apr 07 10:10:54 2023 -0700 |
| committer | Varun Patil <varunpatil@ucla.edu> | Mon Apr 10 12:47:43 2023 -0700 |
| tree | d06dec1b7f60b2fca8b76c43af588ea97682e827 | |
| parent | ffe858c5955a1b5460e8fad95ff0c33bc9085026 [diff] |
types: reserve "ignored" type Change-Id: I93651245ca4d80c6466ab1aa4f53254a95c4679f
This repository contains the base packet format specification of the Named Data Networking (NDN) protocol.
An HTML version of the specification can be viewed online at https://docs.named-data.net/NDN-packet-spec/.
To "compile" the specification in HTML format, you must first install the Sphinx documentation generator and a few other dependencies. To do so, first make sure that the following packages are installed and up to date:
For instance, on Ubuntu Linux you can use the following commands:
sudo apt install make python3-pip python3 -m pip install -U pip
On other operating systems, you can either use your preferred package manager or follow pip's installation instructions.
Finally, run:
python3 -m pip install -r requirements.txt
to install the recommended version of Sphinx and its dependencies.
Just type:
make html
And a set of HTML pages will be generated inside _build/html.
You can also type:
make latexpdf
Sphinx will generate a .tex file and will try to compile it into a PDF document using latexmk and pdflatex (which must be installed). If successful, the final .pdf file can be found in _build/latex.
For further options, type make help.