25 lines
579 B
Text
25 lines
579 B
Text
|
Building the doc locally
|
||
|
|
============================
|
||
|
|
|
||
|
|
install
|
||
|
|
---------
|
||
|
|
|
||
|
|
First, install a python virtual environment::
|
||
|
|
|
||
|
|
python -m venv .venv
|
||
|
|
source .venv/bin/activate
|
||
|
|
|
||
|
|
Then install the sphinx libraries::
|
||
|
|
|
||
|
|
./.venv/bin/pip3 install sphinx
|
||
|
|
./.venv/bin/pip3 install sphinx_rtd_theme
|
||
|
|
./.venv/bin/pip3 install sphinx_lesson
|
||
|
|
|
||
|
|
The generatef html output is located in the `docs/build/html` subfolder,
|
||
|
|
you can modify the target or the output type in the :file:`docs/Makefile`.
|
||
|
|
|
||
|
|
scraps
|
||
|
|
---------
|
||
|
|
|
||
|
|
`variable <https://en.wikipedia.org/wiki/Variable_(computer_science)>`_
|