[Bro-Dev] Generate bro documentation

Gregor Maier gregor at icir.org
Thu Aug 4 16:29:46 PDT 2011

On 8/4/11 15:14 , Jonathan Siwek wrote:
>> how can I generate the autodocs from Bro. I guess running bro with -Z
>> and loading all.bro, right? This gives me the rst files. How can I then
>> run sphinx to get the HTLM output?
> There are two Makefile targets `restdoc` and `doc`.  The former generates just reST and the later renders it to HTML using sphinx.  See doc/scripts/README

Cool, thanks.

>> Would be great if you could also add that info to:
>> http://www.bro-ids.org/development/autodoc.html
> Will add something.

Thanks. Just the above sentence is already pretty good I think.

Gregor Maier
<gregor at icir.org>  <gregor at icsi.berkeley.edu>
Int. Computer Science Institute (ICSI)
1947 Center St., Ste. 600
Berkeley, CA 94704, USA

More information about the bro-dev mailing list