| commit | 6b2bb6294f47edb709b5fe7fe66cf44734b65292 | [log] [tgz] |
|---|---|---|
| author | Davide Pesavento <davidepesa@gmail.com> | Thu Jan 12 22:00:44 2023 -0500 |
| committer | Davide Pesavento <davidepesa@gmail.com> | Tue Jan 17 22:00:06 2023 -0500 |
| tree | 46b4c77f429927e05e35d368faa40c381e6744b1 | |
| parent | 1bd99a89ba430af69bbe8499b3d393065649f61e [diff] |
Add workflow for continuous deployment of HTML pages Change-Id: I38655455658f83cd5eab24a7b58c7f3d15969c8d
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.