From 7e0864468cbc7f8fd629e0e2cb7c983883dff8bb Mon Sep 17 00:00:00 2001 From: Jon Siwek Date: Thu, 21 Nov 2013 15:59:07 -0600 Subject: [PATCH] A couple documentation fixes. - 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). --- doc/frameworks/sumstats.rst | 2 +- doc/script-reference/index.rst | 1 + doc/{scripts => script-reference}/notices.rst | 0 3 files changed, 2 insertions(+), 1 deletion(-) rename doc/{scripts => script-reference}/notices.rst (100%) diff --git a/doc/frameworks/sumstats.rst b/doc/frameworks/sumstats.rst index 057cc87fc1..6ab2f43b35 100644 --- a/doc/frameworks/sumstats.rst +++ b/doc/frameworks/sumstats.rst @@ -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 demonstrate how thresholding works in Sumstats and is not meant to be a 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 diff --git a/doc/script-reference/index.rst b/doc/script-reference/index.rst index ccb374bd82..bd600e4a97 100644 --- a/doc/script-reference/index.rst +++ b/doc/script-reference/index.rst @@ -5,6 +5,7 @@ Script Reference .. toctree:: :maxdepth: 1 + notices proto-analyzers file-analyzers builtins diff --git a/doc/scripts/notices.rst b/doc/script-reference/notices.rst similarity index 100% rename from doc/scripts/notices.rst rename to doc/script-reference/notices.rst