]> git.ipfire.org Git - thirdparty/suricata.git/commit
devguide: move image generation into sphinx setup
authorJason Ish <jason.ish@oisf.net>
Mon, 31 Jan 2022 18:06:55 +0000 (12:06 -0600)
committerVictor Julien <vjulien@oisf.net>
Tue, 1 Feb 2022 06:17:39 +0000 (07:17 +0100)
commitb9a429e6ce11b6e140ce567d6eaeb5132524744f
treebd00b300631c687343608a3d4b33d20978217bde
parent4247605d874113ef13003816007e0575219d065e
devguide: move image generation into sphinx setup

While ReadTheDocs can't execute arbitrary scripts, we can install
mscgen in the container that builds the docs (see .readthedocs.yaml).

Then instead of calling generate-images.sh from the Makefile, move this
into the setup function defined on conf.yaml, which will generate the
scripts as part of a normal Sphinx workflow.

This should give us an image generation solution that works on
ReadTheDocs, and locally within anyones build system provided they have
mscgen installed.
.readthedocs.yaml
doc/devguide/Makefile.am
doc/devguide/conf.py
doc/devguide/tools/generate-images.sh