[Bro-Dev] Thoughts on documenting scripts

Gregor Maier gregor at icir.org
Tue Nov 23 10:00:45 PST 2010

>> Very nice, I like the overall setup, it looks like a smooth way to
>> automate the documentation generation process for Bro scripts! A few
>> comments:
> BTW, how does this all fit with the one language to rule them all goal, i.e. ReST? Or is rest just for the web site, manual and Bro book?

Sphinx is based on ReST. It defines additional rest directive to make
writing code documentation easier. But the markup in the docstrings is


Gregor Maier                                             gregor at icir.org
Int. Computer Science Institute (ICSI)          gregor at icsi.berkeley.edu
1947 Center St., Ste. 600                    http://www.icir.org/gregor/
Berkeley, CA 94704

More information about the bro-dev mailing list