mirror of https://github.com/OISF/suricata
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
b9a429e6ce
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 | |
|---|---|---|
| .. | ||
| _static | ||
| codebase | ||
| extending | ||
| internals | ||
| tools | ||
| .gitignore | ||
| Makefile.am | ||
| Makefile.sphinx | ||
| README.md | ||
| conf.py | ||
| index.rst | ||
README.md
Suricata Developer Guide
This directory contains the Suricata Developer Guide. The Sphinx Document Generator is used to build the documentation. For a primer os reStructuredText see the reStructuredText Primer.
Verifying Changes
There are a number of output formats to choose from when making the source documentation locally (e.g. html, pdf, man).
The documentation source can be built with make -f Makefile.sphinx html. Substitute the 'html' word for desired output format.
There are different application dependencies based on the output desired.