commit | ec74676176eb54d38c80a2cc9b92547931dcb466 | [log] [tgz] |
---|---|---|
author | Davide Pesavento <davidepesa@gmail.com> | Wed Jun 24 22:57:31 2020 -0400 |
committer | Davide Pesavento <davidepesa@gmail.com> | Wed Jun 24 22:57:31 2020 -0400 |
tree | 03d956fa787e8cf57ef3f285ef686f3c43082f53 | |
parent | 4d17760e17e042d47616d6ef621bfa9a69c1ab01 [diff] |
Enable syntax highlighting of code blocks (mostly ABNF) Change-Id: Iaaf02dc02cc232518421fa3591004d2bb5939440
To "compile" the specification in HTML format, you must first install the Sphinx documentation generator.
If you're running Ubuntu Linux:
sudo apt install make python3-pip pip3 install -U pip setuptools pip3 install -U sphinx sphinxcontrib-bibtex sphinxcontrib-fulltoc
If you're running macOS or another operating system, see the instructions at https://www.sphinx-doc.org/en/master/usage/installation.html
Just type:
make html
And a set of HTML pages will be generated under _build/html
.
You can also type:
make latexpdf
Sphinx will generate a .tex
file and will try to create a .pdf
document from it using pdflatex
(which must be installed).
For further options, type make help
.