mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 06:38:20 +00:00
9967aea52c
Add a "broxygen" domain Sphinx extension w/ directives to allow on-the-fly documentation to be generated w/ Bro and included in files. This means all autogenerated reST docs are now done by Bro. The odd CMake/Python glue scipts which used to generate some portions are now gone. Bro and the Sphinx extension handle checking for outdated docs themselves. Parallel builds of `make doc` target should now work (mostly because I don't think there's any tasks that can be done in parallel anymore). Overall, this seems to simplify things and make the Broxygen-generated portions of the documentation visible/traceable from the main Sphinx source tree. The one odd thing still is that per-script documentation is rsync'd in to a shadow copy of the Sphinx source tree within the build dir. This is less elegant than using the new broxygen extension to make per-script docs, but rsync is faster and simpler. Simpler as in less code because it seems like, in the best case, I'd need to write a custom Sphinx Builder to be able to get that to even work. |
||
|---|---|---|
| .. | ||
| connection_record_01.bro | ||
| connection_record_02.bro | ||
| data_struct_record_01.bro | ||
| data_struct_record_02.bro | ||
| data_struct_set_declaration.bro | ||
| data_struct_table_complex.bro | ||
| data_struct_table_declaration.bro | ||
| data_struct_vector.bro | ||
| data_struct_vector_declaration.bro | ||
| data_struct_vector_iter.bro | ||
| data_type_const.bro | ||
| data_type_const_simple.bro | ||
| data_type_declaration.bro | ||
| data_type_interval.bro | ||
| data_type_local.bro | ||
| data_type_pattern_01.bro | ||
| data_type_pattern_02.bro | ||
| data_type_subnets.bro | ||
| data_type_time.bro | ||
| framework_logging_factorial_01.bro | ||
| framework_logging_factorial_02.bro | ||
| framework_logging_factorial_03.bro | ||
| framework_logging_factorial_04.bro | ||
| framework_notice_hook_01.bro | ||
| framework_notice_hook_suppression_01.bro | ||
| framework_notice_shortcuts_01.bro | ||
| framework_notice_shortcuts_02.bro | ||
| index.rst | ||
| using_bro_sandbox_01 | ||
| using_bro_sandbox_02 | ||