mirror of
https://github.com/zeek/zeek.git
synced 2025-10-07 09:08:20 +00:00
3abf626908
BIT-1098 * origin/topic/jsiwek/broxygen: Fix Broxygen-related compile errors. Add a Broxygen coverage test. Internal Broxygen organization/documentation/polish. Add unit tests for Broxygen config file targets. Change Broxygen config file format. Broxygen doc-related test updates. Fix two regressions. A couple documentation fixes. Integrate new Broxygen functionality into Sphinx. Implement majority of Broxygen features delegated to Bro. Broxygen can now read a config file specifying particular targets. Remove unneeded Broxygen comments in scan.bro. Replace safe_basename/safe_dirname w/ SafeBasename/SafeDirname. Add BIF interface for retrieving comments/docs. Quick optimization to Broxygen doc gathering. Flesh out Broxygen doc-gathering skeleton. Refactor search_for_file() util function. Initial skeleton of new Broxygen infrastructure. |
||
|---|---|---|
| .. | ||
| _static | ||
| _templates | ||
| cluster | ||
| components | ||
| ext | ||
| frameworks | ||
| images | ||
| install | ||
| intro | ||
| quickstart | ||
| script-reference | ||
| scripting | ||
| using | ||
| .gitignore | ||
| broxygen.conf.in | ||
| CMakeLists.txt | ||
| conf.py.in | ||
| index.rst | ||
| LICENSE | ||
| README | ||
Documentation ============= This directory contains Bro documentation in reStructuredText format (see http://docutils.sourceforge.net/rst.html). It is the root of a Sphinx source tree and can be modified to add more common/general documentation, style sheets, JavaScript, etc. The Sphinx config file is produced from ``conf.py.in``, and can be edited to change various Sphinx options. There is also a custom Sphinx domain implemented in ``source/ext/bro.py`` which adds some reST directives and roles that aid in generating useful index entries and cross-references. Other extensions can be added in a similar fashion. The ``make doc`` target in the top-level Makefile can be used to locally render the reST files into HTML. That target depends on: * Python interpreter >= 2.5 * `Sphinx <http://sphinx.pocoo.org/>`_ >= 1.0.1 After completion, HTML documentation is symlinked in ``build/html``. There's also a ``make docclean`` target which deletes any files created during the documentation build process. Notes for Writing Documentation ------------------------------- * If you want to refer to a document that's part of the distribution, it currently needs to be copied or otherwise symlinked somewhere in to this Sphinx source tree. Then, it can be referenced in a toc tree or with the :doc: role. Use the :download: role to refer to static files that will not undergo sphinx rendering. * If you want to refer to a page on the Bro web site, use an HTTP URL. Guidelines ---------- TODO.