commit | f2eb359ea0a6f48d0e4b09d70a594c1dffdbc10e | [log] [tgz] |
---|---|---|
author | Davide Pesavento <davidepesa@gmail.com> | Thu Dec 02 19:24:22 2021 -0500 |
committer | Davide Pesavento <davidepesa@gmail.com> | Thu Dec 02 19:24:22 2021 -0500 |
tree | 4defa031c7cc0ec42ccaaeab61c866c17c470c84 | |
parent | 52c88cb1b16c8e03df7a3bf6a6789d93b8f9da87 [diff] |
Add a requirements file Change-Id: I892ce76b857a76c4a76a72b2386dba71cd885eb9
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
.