tlv: rewrite syntax specifications using IETF ABNF

refs #4853

Change-Id: Iad79a63675279d53de2f7bb4891d10bf01d0424f
9 files changed
tree: 88b18a91746b355eecd45ba4e928a2a945c8b9e9
  1. _static/
  2. named_data_theme/
  3. .gitignore
  4. changelog.rst
  5. conf.py
  6. data.rst
  7. index.rst
  8. interest.rst
  9. intro.rst
  10. link.rst
  11. Makefile
  12. name.rst
  13. ndnspec-refs.bib
  14. README.md
  15. signature.rst
  16. signed-interest.rst
  17. tlv.rst
  18. types.rst
README.md

Prerequisites

To "compile" documentation into html form you would need to install Sphinx documentation package, which should be relatively trivial.

If you're on macOS:

If you're on Ubuntu Linux 16.04:

sudo apt install python3-pip
sudo pip3 install -U pip setuptools
sudo pip3 install -U sphinx sphinxcontrib-bibtex sphinxcontrib-fulltoc

Compilation

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.