commit | 04af5f2d562f2245f7b890b94d8c443d9ef3da95 | [log] [tgz] |
---|---|---|
author | Davide Pesavento <davidepesa@gmail.com> | Sun Jun 21 22:02:47 2020 -0400 |
committer | Davide Pesavento <davidepesa@gmail.com> | Mon Jun 22 16:50:45 2020 -0400 |
tree | 01e12affaea49b5aebcaafc36979ba5205fb2449 | |
parent | b168f7ce0d728a77a2665601e80e6d9ca5c4a8a9 [diff] |
Modernize conf.py and Makefile Change-Id: I3d6f87c4557fded89b84522ef09d677863a62344
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
.