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.
752e4828d7
Required for distcheck to pass, and required to build docs from a dist archive. |
5 years ago | |
|---|---|---|
| .. | ||
| _static | 5 years ago | |
| app-layer | 5 years ago | |
| .gitignore | 5 years ago | |
| Makefile.am | 5 years ago | |
| Makefile.sphinx | 5 years ago | |
| README.md | 5 years ago | |
| code-style.rst | 5 years ago | |
| code-submission-process.rst | 5 years ago | |
| conf.py | 5 years ago | |
| index.rst | 5 years ago | |
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.