| commit | 4d6c3578065c78a4e86a3a754934fffc93701e63 | [log] [tgz] |
|---|---|---|
| author | Davide Pesavento <davidepesa@gmail.com> | Fri May 27 12:05:05 2022 -0400 |
| committer | Davide Pesavento <davidepesa@gmail.com> | Tue Jun 07 00:55:01 2022 -0400 |
| tree | 20e2657f779c7c3130ea87100fe6387e834f4348 | |
| parent | ac25eabf035dd87dc6a27076b004cc8009c01d8a [diff] |
Use :rfc: and :abbr: sphinx roles Change-Id: I34e0ddbd644944d98a26f9c0c93ad787b4d93679
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 pip3 install -r requirements.txt
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 inside _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.