mirror of
https://github.com/zeek/zeek.git
synced 2025-10-07 00:58:19 +00:00
Update the generated script doc organization.
Added an additional master TOC index for Bro script packages that automatically gets filled in at ``make doc`` time. The master TOC links to per-package indexes which contains links to all the scripts contained within it along with their summary. The per-package index is also now automatically generated/derived from the path component of the script passed into the rest_target() macro.
This commit is contained in:
parent
fe5f4b8e53
commit
5a2cd265ab
22 changed files with 229 additions and 236 deletions
|
@ -64,11 +64,6 @@ The Bro scripting language supports the following built-in types.
|
|||
|
||||
.. bro:type:: event
|
||||
|
||||
.. TODO: Notice will get documented as part of notice.bro, which can eventually
|
||||
be referenced here once that documentation is auto-generated.
|
||||
|
||||
.. bro:type:: Notice
|
||||
|
||||
Attributes
|
||||
----------
|
||||
|
||||
|
|
|
@ -1,3 +0,0 @@
|
|||
Bro Scripts Loaded by Default
|
||||
=============================
|
||||
|
|
@ -11,20 +11,10 @@ Contents:
|
|||
|
||||
common
|
||||
builtins
|
||||
default
|
||||
bifs
|
||||
policy/dns-index
|
||||
policy/ftp-index
|
||||
policy/http-index
|
||||
policy/irc-index
|
||||
policy/metrics-index
|
||||
policy/mime-index
|
||||
policy/sig-index
|
||||
policy/smtp-index
|
||||
policy/software-index
|
||||
policy/ssh-index
|
||||
policy/ssl-index
|
||||
internal
|
||||
bifs
|
||||
packages
|
||||
collections
|
||||
policy/index
|
||||
|
||||
Indices and tables
|
||||
|
|
13
doc/scripts/source/packages.rst
Normal file
13
doc/scripts/source/packages.rst
Normal file
|
@ -0,0 +1,13 @@
|
|||
.. This is a stub doc to which the build process can append.
|
||||
|
||||
Policy Script Packages
|
||||
======================
|
||||
|
||||
Bro has the following policy script packages (e.g. collections of related
|
||||
policy scripts). If the package contains a ``__load__.bro`` script, it
|
||||
supports being loaded in mass as a whole directory for convenience.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
.. This is a stub doc to which the build process can append.
|
||||
|
||||
DNS Policy Scripts
|
||||
==================
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
.. This is a stub doc to which the build process can append.
|
||||
|
||||
FTP Policy Scripts
|
||||
==================
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
.. This is a stub doc to which the build process can append.
|
||||
|
||||
HTTP Policy Scripts
|
||||
===================
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
.. This is a stub doc to which the build process can append.
|
||||
|
||||
IRC Policy Scripts
|
||||
==================
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
.. This is a stub doc to which the build process can append.
|
||||
|
||||
Metrics Policy Scripts
|
||||
======================
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
.. This is a stub doc to which the build process can append.
|
||||
|
||||
MIME Policy Scripts
|
||||
===================
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
.. This is a stub doc to which the build process can append.
|
||||
|
||||
Signature Policy Scripts
|
||||
========================
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
.. This is a stub doc to which the build process can append.
|
||||
|
||||
SMTP Policy Scripts
|
||||
===================
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
.. This is a stub doc to which the build process can append.
|
||||
|
||||
Software Policy Scripts
|
||||
=======================
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
.. This is a stub doc to which the build process can append.
|
||||
|
||||
SSH Policy Scripts
|
||||
==================
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
.. This is a stub doc to which the build process can append.
|
||||
|
||||
SSL Policy Scripts
|
||||
==================
|
||||
|
Loading…
Add table
Add a link
Reference in a new issue