mirror of
https://github.com/zeek/zeek.git
synced 2025-10-07 17:18:20 +00:00
7e9d48f532
The broxygen-generated files now live in the git repo, have tests that check that they are up-to-date, and a script to re-generate them on-demand.
37 lines
1.3 KiB
ReStructuredText
37 lines
1.3 KiB
ReStructuredText
:orphan:
|
|
|
|
Package: broxygen
|
|
=================
|
|
|
|
This package is loaded during the process which automatically generates
|
|
reference documentation for all Bro scripts (i.e. "Broxygen"). Its only
|
|
purpose is to provide an easy way to load all known Bro scripts plus any
|
|
extra scripts needed or used by the documentation process.
|
|
|
|
:doc:`/scripts/broxygen/__load__.bro`
|
|
|
|
|
|
:doc:`/scripts/broxygen/example.bro`
|
|
|
|
This is an example script that demonstrates Broxygen-style
|
|
documentation. It generally will make most sense when viewing
|
|
the script's raw source code and comparing to the HTML-rendered
|
|
version.
|
|
|
|
Comments in the from ``##!`` are meant to summarize the script's
|
|
purpose. They are transferred directly in to the generated
|
|
`reStructuredText <http://docutils.sourceforge.net/rst.html>`_
|
|
(reST) document associated with the script.
|
|
|
|
.. tip:: You can embed directives and roles within ``##``-stylized comments.
|
|
|
|
There's also a custom role to reference any identifier node in
|
|
the Bro Sphinx domain that's good for "see alsos", e.g.
|
|
|
|
See also: :bro:see:`BroxygenExample::a_var`,
|
|
:bro:see:`BroxygenExample::ONE`, :bro:see:`SSH::Info`
|
|
|
|
And a custom directive does the equivalent references:
|
|
|
|
.. bro:see:: BroxygenExample::a_var BroxygenExample::ONE SSH::Info
|
|
|