mirror of
https://github.com/zeek/zeek.git
synced 2025-10-02 06:38:20 +00:00
28 lines
1 KiB
Text
28 lines
1 KiB
Text
|
|
Documentation
|
|
=============
|
|
|
|
This directory contains 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
|
|
documentation, style sheets, JavaScript, etc. The Sphinx config file
|
|
is ``conf.py``.
|
|
|
|
There is also a custom Sphinx domain implemented in ``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.7
|
|
* `Sphinx <http://sphinx-doc.org/>`_
|
|
* `Read the Docs Sphinx Theme <https://github.com/rtfd/sphinx_rtd_theme>`_
|
|
|
|
After the build completes, HTML documentation is symlinked in ``build/html``.
|
|
|
|
There's also a ``make livehtml`` target in the top-level Makefile that
|
|
is useful for editing the reST files and seeing changes rendered out live
|
|
to a separate HTML browser.
|