| commit | 23e340cb138afa95ee228dffb8c50870eea26633 | [log] [tgz] |
|---|---|---|
| author | Davide Pesavento <davidepesa@gmail.com> | Fri Dec 03 04:52:22 2021 -0500 |
| committer | Davide Pesavento <davidepesa@gmail.com> | Fri Dec 03 04:52:22 2021 -0500 |
| tree | 2a4a8de8ce072307fb46692f4c0f954f100cfa3e | |
| parent | f2eb359ea0a6f48d0e4b09d70a594c1dffdbc10e [diff] |
Improve the document structure in several places Change-Id: Icea6d0b0d9628eb171f5673b397f1db7f1c5c5b8
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.