]> git.ipfire.org Git - thirdparty/suricata.git/commit
doc/userguide: generate eve documentation 11895/head
authorJason Ish <jason.ish@oisf.net>
Mon, 5 Jun 2023 19:56:59 +0000 (13:56 -0600)
committerVictor Julien <victor@inliniac.net>
Mon, 7 Oct 2024 20:28:04 +0000 (22:28 +0200)
commit6ae5ae701bae2419c034455e6be8823d0f002a7d
treeb5a4dfbc985e3ff0412ffbc78fec5c78cd31453a
parent2626895a93695cf2bee3966d09e1032e8655c488
doc/userguide: generate eve documentation

Add EVE documentation for QUIC and Pgsql to their respective sections of
the userguide.

Also add a complete EVE reference as an appendix.

Other protocols can be done, but its a manual process to document in the
schema, then add the glue to pull them into the documentation.

The documentation is generated during "make dist", or if it doesn't
exist, "conf.py" will attempt to generate the eve documentation for
building on Readthedocs.
Makefile.am
doc/userguide/.gitignore
doc/userguide/Makefile.am
doc/userguide/appendix/eve-index.rst [new file with mode: 0644]
doc/userguide/appendix/index.rst [new file with mode: 0644]
doc/userguide/conf.py
doc/userguide/generate-evedoc.sh [new file with mode: 0755]
doc/userguide/index.rst
doc/userguide/output/eve/eve-json-format.rst
etc/Makefile.am