Generate bro documentation

Development
1

Hi,

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?

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

And/or provide a shell-script that will do all that.

cu
Gregor

2

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

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

Will add something.

- Jon

3

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.

cu
gregor

4

BTW, there are some problems with sphinx-build using Mac OS X with MacPorts. Probably because I'm doing something wrong with MacPorts.

When I just install the "py-sphinx" port I get a sphinx-build binary, but the version of sphinx is so ancient, that it's not compatible with the Makefile (doesn't have a -c option).

I can also install one of the many "py2.x-sphinx" ports (e.g., 2.6). Then I get a sphinx-build binary that works with the Makefile but the port only installs it as "sphinx-build-2.6". I.e., I have to manually create a symlink. Grrr.

So question is: should cmake try to figure out if there's an awkwardly named sphinx-build binary so it works with MacPorts? Or is there a way that I can tell MacPorts to create a symlink for the binary.

Thx,
Gregor

5

So question is: should cmake try to figure out if there's an awkwardly named sphinx-build binary so it works with MacPorts? Or is there a way that I can tell MacPorts to create a symlink for the binary.

I don't know about getting MacPorts to do that, but the CMake script could be made more configurable about finding the right "sphinx-build" -- the typical Find* package macros could be used instead of hardcoding it like it is now.

- Jon