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