suricata

Commit Graph

Author	SHA1	Message	Date
Jason Ish	b9a429e6ce	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.	3 years ago
Jason Ish	6e3e8530a1	readthedocs: add configuration file	3 years ago

Author

SHA1

Message

Date

Jason Ish

b9a429e6ce

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.

Jason Ish

6e3e8530a1

readthedocs: add configuration file

2 Commits (6c616d84b18dbc518c4107f0fe6c7386a3d4e5f2)