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:
Jon Siwek 2011-06-30 16:58:20 -05:00
parent fe5f4b8e53
commit 5a2cd265ab
22 changed files with 229 additions and 236 deletions

View file

@ -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
----------

View file

@ -1,3 +0,0 @@
Bro Scripts Loaded by Default
=============================

View file

@ -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

View 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

View file

@ -1,5 +0,0 @@
.. This is a stub doc to which the build process can append.
DNS Policy Scripts
==================

View file

@ -1,5 +0,0 @@
.. This is a stub doc to which the build process can append.
FTP Policy Scripts
==================

View file

@ -1,5 +0,0 @@
.. This is a stub doc to which the build process can append.
HTTP Policy Scripts
===================

View file

@ -1,5 +0,0 @@
.. This is a stub doc to which the build process can append.
IRC Policy Scripts
==================

View file

@ -1,5 +0,0 @@
.. This is a stub doc to which the build process can append.
Metrics Policy Scripts
======================

View file

@ -1,5 +0,0 @@
.. This is a stub doc to which the build process can append.
MIME Policy Scripts
===================

View file

@ -1,5 +0,0 @@
.. This is a stub doc to which the build process can append.
Signature Policy Scripts
========================

View file

@ -1,5 +0,0 @@
.. This is a stub doc to which the build process can append.
SMTP Policy Scripts
===================

View file

@ -1,5 +0,0 @@
.. This is a stub doc to which the build process can append.
Software Policy Scripts
=======================

View file

@ -1,5 +0,0 @@
.. This is a stub doc to which the build process can append.
SSH Policy Scripts
==================

View file

@ -1,5 +0,0 @@
.. This is a stub doc to which the build process can append.
SSL Policy Scripts
==================