Skip to content
This repository has been archived by the owner on May 4, 2021. It is now read-only.

docs: graphviz is required to build diagrams #365

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: graphviz is required to build diagrams #365

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions docs/source/documenting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,11 @@ To build the manual (``man``) pages::

The generated man pages will be in ``docs/man/``.

To build the documentation diagrams::
To build the documentation diagrams, extra system dependencies are needed::

apt-get install graphviz

You can then build the diagrams with::

cd docs/ && make umlsvg

Expand All @@ -46,4 +50,4 @@ They are included in most distributions. In Debian install them running::
.. _recommonmark: https://recommonmark.readthedocs.io/
.. _Pylint: https://www.pylint.org/
.. _Tex: https://www.tug.org/texlive/acquire.html
.. _dvipng: https://www.nongnu.org/dvipng/
.. _dvipng: https://www.nongnu.org/dvipng/