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.
6c616d84b1
As the GetFrameIdByName can be probed, we must warn developers not to leave any output in them, or misleading messages could be printed. Task #5129 |
3 years ago | |
|---|---|---|
| .. | ||
| _static | ||
| codebase | ||
| extending | 3 years ago | |
| internals | ||
| tools | ||
| .gitignore | ||
| Makefile.am | 3 years ago | |
| 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.