Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: generate eve reference - v7 #11894

Closed
wants to merge 2 commits into from
Closed

doc: generate eve reference - v7 #11894

wants to merge 2 commits into from

Commits on Oct 7, 2024

  1. evedoc.py: script to generate rst doc from eve schema 

    Also supports a "--flat" command line option to produce a "dot"
separated version of all the fields in the EVE schema.
    @jasonish
    jasonish committed Oct 7, 2024
    Configuration menu
    Copy the full SHA
    cb91bbf View commit details
    Browse the repository at this point in the history

  2. 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.
    @jasonish
    jasonish committed Oct 7, 2024
    Configuration menu
    Copy the full SHA
    68bd120 View commit details
    Browse the repository at this point in the history