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.
9488002a0d
Older versions of Sphinx will generate duplicate IDs when you have options like: .. option:: some-option .. option:: some-other-option The version of Sphinx provided on CentOS 7 has this issue, newer versions of Sphinx do not. As CentOS 7 is still a popular distribution, change ".. option" to ".. describe" which has the same visual output, but does not generate links. |
6 years ago | |
|---|---|---|
| .. | ||
| 3rd-party-integration | 7 years ago | |
| _static | 8 years ago | |
| capture-hardware | 6 years ago | |
| configuration | 6 years ago | |
| file-extraction | 7 years ago | |
| licenses | 6 years ago | |
| lua | 7 years ago | |
| manpages | 7 years ago | |
| output | 6 years ago | |
| partials | 6 years ago | |
| performance | 6 years ago | |
| reputation | 6 years ago | |
| rule-management | 6 years ago | |
| rules | 6 years ago | |
| setting-up-ipsinline-for-linux | ||
| .gitignore | ||
| Makefile.am | 7 years ago | |
| Makefile.sphinx | ||
| README.md | 7 years ago | |
| acknowledgements.rst | 8 years ago | |
| command-line-options.rst | ||
| conf.py | 7 years ago | |
| convert.py | ||
| index.rst | 7 years ago | |
| initscripts.rst | ||
| install.rst | 7 years ago | |
| make-sense-alerts.rst | 8 years ago | |
| public-data-sets.rst | 8 years ago | |
| setting-up-ipsinline-for-linux.rst | ||
| setting-up-ipsinline-for-windows.rst | 7 years ago | |
| unix-socket.rst | 6 years ago | |
| what-is-suricata.rst | ||
README.md
Suricata User Guide
This directory contains the Suricata Guide. The Sphinx Document Generate 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.