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
Juliana Fajardini	2cd25e8105	devguide/app-layer: rename /img dir to /diagrams Semantically speaking it makes more sense, because it stores `msc` files for dynamic image generation. Updated files that refered to `img` accordingly, too.	3 years ago
Juliana Fajardini	a5b344e015	doc/devguide: add Transactions documentation page A guide on what is a transaction for Suricata engine, focusing on developers. - What's the purpose of a transaction; - transaction states and API callbacks; - Examples and sequence diagrams. - doc/devguide: add transactions.rst - doc/devguide/extending/app-layer/index.rst: add transactions.rst	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.

Juliana Fajardini

2cd25e8105

devguide/app-layer: rename /img dir to /diagrams

Semantically speaking it makes more sense, because it stores `msc`
files for dynamic image generation.
Updated files that refered to `img` accordingly, too.

Juliana Fajardini

a5b344e015

doc/devguide: add Transactions documentation page

A guide on what is a transaction for Suricata engine, focusing on
developers.
- What's the purpose of a transaction;
- transaction states and API callbacks;
- Examples and sequence diagrams.
- doc/devguide: add transactions.rst
- doc/devguide/extending/app-layer/index.rst: add transactions.rst

3 Commits (97ef60cd9ba956260fefaf08cfe6ad4e6b14747a)