mirror of
https://github.com/OISF/suricata.git
synced 2026-05-04 17:26:33 -04:00
6ae5ae701b
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.
13 lines
436 B
Bash
Executable file
13 lines
436 B
Bash
Executable file
#! /bin/sh
|
|
#
|
|
# Generate RST EVE documentation.
|
|
#
|
|
# This has been broken out of the Makefile so it can be called by
|
|
# make, and Sphinx via conf.py.
|
|
|
|
set -e
|
|
|
|
mkdir -p _generated
|
|
../../scripts/evedoc.py --output _generated/eve-index.rst ../../etc/schema.json
|
|
../../scripts/evedoc.py --output _generated/quic.rst --object quic ../../etc/schema.json
|
|
../../scripts/evedoc.py --output _generated/pgsql.rst --object pgsql ../../etc/schema.json
|