Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-07 17:18:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Overhaul of "doc" build target for generating policy script documentation.

Browse source 
It's now all implemented in CMake scripting.

The generation of reST docs is now a distinct target, "restdoc", while
the target to generate HTML docs, "doc", depends on "restdoc".  reST doc
generation supports incremental builds (documentation for a given policy
script is only regenerated when it is out of date), but HTML doc generation
via ``make doc`` is not incremental (Sphinx always starts with fresh input).

Building the "restdoc" target is now covered by a btest to ensure all
policy scripts are parse-able when Bro is in "doc mode".

Generated reST docs should now support "@load"ing from subdirectories.  e.g.
"@load foo/baz" and "@load bar/baz" will now generate the right xref links.
This commit is contained in:
Jon Siwek 2011-04-26 22:13:04 -05:00
parent 9875c2ba9c
commit f10d2e10ea
14 changed files with 276 additions and 278 deletions
Download patch file Download diff file Expand all files Collapse all files

4
doc/scripts/source/policy/bifs.rst
View file

@ -1,4 +0,0 @@
Built-In Functions (BIFs)
=========================
Here's a list of all documentation for BIFs that Bro provides:

3
doc/scripts/source/policy/default.rst
View file

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

4
doc/scripts/source/policy/index.rst
View file

@ -1,10 +1,6 @@
Index of All Policy Script Documentation
========================================
Contents:
.. toctree::
:maxdepth: 1
:glob:
*

3
doc/scripts/source/policy/internal.rst
View file

@ -1,3 +0,0 @@
Internal Policy Scripts
=======================

3
doc/scripts/source/policy/user.rst
View file

@ -1,3 +0,0 @@
User-Facing Policy Scripts
==========================