From d9983a9ba1d7841e282691691db0278062746ee0 Mon Sep 17 00:00:00 2001 From: Carl Bordum Hansen Date: Thu, 6 Feb 2020 23:27:08 +0100 Subject: [PATCH] docs: `graphviz` is required to build diagrams --- docs/source/documenting.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/source/documenting.rst b/docs/source/documenting.rst index bc74dae6..a43dae7d 100644 --- a/docs/source/documenting.rst +++ b/docs/source/documenting.rst @@ -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 @@ -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/ \ No newline at end of file +.. _dvipng: https://www.nongnu.org/dvipng/