Mirror/zeek
1
0
Fork 0
mirror of https://github.com/zeek/zeek.git synced 2025-10-02 14:48:21 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

A couple documentation fixes.

Browse source 
- Move notice index wrapper doc to doc/script-reference -- doc/scripts
  no longer contains any static documentation because that location
  will be managed by Bro to generate per-script docs.

- :doc: references for generated per-script docs now need the ".bro"
  suffix.  (IMO this is better since it directly mirrors the actual
  script's file name and can't be confused w/ a package).
This commit is contained in:
Jon Siwek 2013-11-21 15:59:07 -06:00
parent 96ba5c82a3
commit 7e0864468c
3 changed files with 2 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/frameworks/sumstats.rst
View file

@ -87,7 +87,7 @@ Taking the previous example even further, we can implement a simple detection
to demonstrate the thresholding functionality. This example is a toy to to demonstrate the thresholding functionality. This example is a toy to
demonstrate how thresholding works in Sumstats and is not meant to be a demonstrate how thresholding works in Sumstats and is not meant to be a
real-world functional example, that is left to the real-world functional example, that is left to the
:doc:`/scripts/policy/misc/scan` script that is included with Bro. :doc:`/scripts/policy/misc/scan.bro` script that is included with Bro.
.. btest-include:: ${DOC_ROOT}/frameworks/sumstats-toy-scan.bro .. btest-include:: ${DOC_ROOT}/frameworks/sumstats-toy-scan.bro

1
doc/script-reference/index.rst
View file

@ -5,6 +5,7 @@ Script Reference
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
notices
proto-analyzers proto-analyzers
file-analyzers file-analyzers
builtins builtins

0
doc/scripts/notices.rst → doc/script-reference/notices.rst
View file