6 commits

Author	SHA1	Message	Date
Jon Siwek	ceaba8077b	Fixes related to make doc handling of script summary text (##! comments) ... - Summary comments (##!) can now be placed at the beginning of BiF files (but still outside C segments). An issue was fixed where these comments would mistakenly be transferred into the generated .func_def file and cause a compile error. I completely removed writing any opt_ws value into the .func_def file because it was currently not writing anything besides whitespace. - The generation of reST for the collecting of "groups" of policy script documentation now happens at build time of `make doc` through the use of a helper script rather than doing this at configure time so that changes to summary text will always be reflected in the documentation.	2011-05-02 15:34:34 -05:00
Jon Siwek	f10d2e10ea	Overhaul of "doc" build target for generating policy script documentation. ... 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.	2011-04-26 22:13:04 -05:00
Jon Siwek	4634d92394	Move stuff related to policy script documentation from doc/ to doc/scripts/	2011-04-20 21:11:32 -05:00
Jon Siwek	b8f6c5bc7d	Improving documention for the Bro script document-generation process ... Some minor organizational revisions to the python scripting.	2011-04-06 16:39:50 -05:00
Jon Siwek	f3b1a6bb9e	Implementing capability to logically group generated policy script docs	2011-04-06 14:38:35 -05:00
Jon Siwek	5183ab409b	Initial implementation of a make doc target to generate script docs.	2011-04-06 12:06:39 -05:00