blob: b625625c17da7f4be12268fd64e94d00a3fb7ce3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
# Suricata User Guide
This directory contains the Suricata Guide. The Suricata Developer's guide
is included as a chapter of the Guide.
The [Sphinx Document Generator](http://sphinx-doc.org) is used to build the
documentation. For a primer os reStructuredText see the
[reStructuredText Primer](http://sphinx-doc.org/rest.html).
## 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.
|
