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.
23 lines
377 B
ReStructuredText
23 lines
377 B
ReStructuredText
|
|
.. Bro documentation master file
|
|
|
|
=================
|
|
Bro Documentation
|
|
=================
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
intro/index.rst
|
|
install/index.rst
|
|
quickstart/index.rst
|
|
using/index.rst
|
|
scripting/index.rst
|
|
frameworks/index.rst
|
|
cluster/index.rst
|
|
script-reference/index.rst
|
|
components/index.rst
|
|
|
|
* :ref:`General Index <genindex>`
|
|
* :ref:`search`
|
|
|