1.. _documenting:
2
3Installing and building the documentation
4-----------------------------------------
5
6To build the documentation, extra Python dependencies are needed:
7
8- Sphinx_
9- Pylint_ (only to update the diagrams)
10
11To install them from ``sbws``::
12
13    pip install .[doc]
14
15To build the documentation as HTML::
16
17    cd docs/ && make html
18
19The generated HTML will be in ``docs/build/``.
20
21To build the manual (``man``) pages::
22
23    cd docs/ && make man
24
25The generated man pages will be in ``docs/man/``.
26
27To build the documentation diagrams::
28
29    cd docs/ && make umlsvg
30
31The generated diagrams will be in ``docs/build/_images/``.
32
33To convert the ``LaTeX`` mathematical formulae to images, extra system dependencies
34are needed:
35
36- Core and Extra Tex_ Live packages
37- dvipng_
38
39They are included in most distributions. In Debian install them running::
40
41    apt install texlive-latex-extra dvpipng
42
43
44.. _Sphinx: https://www.sphinx-doc.org
45.. _Pylint: https://www.pylint.org/
46.. _Tex: https://www.tug.org/texlive/acquire.html
47.. _dvipng: https://www.nongnu.org/dvipng/
48
49