Commit 364390f9 authored by juga's avatar juga
Browse files

Create page for documentation instructions

parent 62beb662
Loading
Loading
Loading
Loading
+16 −1
Original line number Diff line number Diff line
.. _documentation:
.. _documenting:

Installing documentation dependendencies and building it
---------------------------------------------------------
@@ -30,3 +30,18 @@ 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

They are included in most distributions. In Debian install them running::

    apt install texlive-latex-extra


.. _Sphinx: http://www.sphinx-doc.org
.. _recommonmark: https://recommonmark.readthedocs.io/
.. _Pylint: https://www.pylint.org/
.. _Tex: http://www.tug.org/texlive/acquire.html