mirror of
https://github.com/zeek/zeek.git
synced 2025-10-11 19:18:19 +00:00
Use Sphinx RTD theme for user manual
This commit is contained in:
Jon Siwek
parent
ce320ce984
commit
9f642bfe5b
11 changed files with 52 additions and 1381 deletions
37
doc/README
37
doc/README
|
|
@ -2,13 +2,12 @@
|
||||||
Documentation
|
Documentation
|
||||||
=============
|
=============
|
||||||
|
|
||||||
This directory contains Bro documentation in reStructuredText format
|
This directory contains documentation in reStructuredText format
|
||||||
(see http://docutils.sourceforge.net/rst.html).
|
(see http://docutils.sourceforge.net/rst.html).
|
||||||
|
|
||||||
It is the root of a Sphinx source tree and can be modified to add more
|
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
|
documentation, style sheets, JavaScript, etc. The Sphinx config file
|
||||||
config file is produced from ``conf.py.in``, and can be edited to change
|
is ``conf.py``.
|
||||||
various Sphinx options.
|
|
||||||
|
|
||||||
There is also a custom Sphinx domain implemented in ``ext/bro.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
|
which adds some reST directives and roles that aid in generating useful
|
||||||
|
|
@ -18,30 +17,8 @@ a similar fashion.
|
||||||
The ``make doc`` target in the top-level Makefile can be used to locally
|
The ``make doc`` target in the top-level Makefile can be used to locally
|
||||||
render the reST files into HTML. That target depends on:
|
render the reST files into HTML. That target depends on:
|
||||||
|
|
||||||
* Python interpreter >= 2.5
|
* Python interpreter >= 2.7
|
||||||
* `Sphinx <http://sphinx-doc.org/>`_ >= 1.0.1
|
* `Sphinx <http://sphinx-doc.org/>`_
|
||||||
* Doxygen (required only for building the Broccoli API doc)
|
* `Read the Docs Sphinx Theme <https://github.com/rtfd/sphinx_rtd_theme>`_
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
After the build completes, HTML documentation is symlinked in ``build/html``.
|
||||||
|
|
|
||||||
1
doc/_static/960.css
vendored
1
doc/_static/960.css
vendored
File diff suppressed because one or more lines are too long
522
doc/_static/basic.css
vendored
522
doc/_static/basic.css
vendored
|
|
@ -1,522 +0,0 @@
|
||||||
/*
|
|
||||||
* basic.css
|
|
||||||
* ~~~~~~~~~
|
|
||||||
*
|
|
||||||
* Sphinx stylesheet -- basic theme.
|
|
||||||
*
|
|
||||||
* :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
|
|
||||||
* :license: BSD, see LICENSE for details.
|
|
||||||
*
|
|
||||||
*/
|
|
||||||
|
|
||||||
/* -- main layout ----------------------------------------------------------- */
|
|
||||||
|
|
||||||
div.clearer {
|
|
||||||
clear: both;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- relbar ---------------------------------------------------------------- */
|
|
||||||
|
|
||||||
div.related {
|
|
||||||
width: 100%;
|
|
||||||
font-size: 90%;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.related h3 {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.related ul {
|
|
||||||
margin: 0;
|
|
||||||
padding: 0 0 0 10px;
|
|
||||||
list-style: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.related li {
|
|
||||||
display: inline;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.related li.right {
|
|
||||||
float: right;
|
|
||||||
margin-right: 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- sidebar --------------------------------------------------------------- */
|
|
||||||
|
|
||||||
div.sphinxsidebarwrapper {
|
|
||||||
padding: 10px 5px 0 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar {
|
|
||||||
float: left;
|
|
||||||
width: 230px;
|
|
||||||
margin-left: -100%;
|
|
||||||
font-size: 90%;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar ul {
|
|
||||||
list-style: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar ul ul,
|
|
||||||
div.sphinxsidebar ul.want-points {
|
|
||||||
margin-left: 20px;
|
|
||||||
list-style: square;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar ul ul {
|
|
||||||
margin-top: 0;
|
|
||||||
margin-bottom: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar form {
|
|
||||||
margin-top: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar input {
|
|
||||||
border: 1px solid #98dbcc;
|
|
||||||
font-family: sans-serif;
|
|
||||||
font-size: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar input[type="text"] {
|
|
||||||
width: 170px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar input[type="submit"] {
|
|
||||||
width: 30px;
|
|
||||||
}
|
|
||||||
|
|
||||||
img {
|
|
||||||
border: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- search page ----------------------------------------------------------- */
|
|
||||||
|
|
||||||
ul.search {
|
|
||||||
margin: 10px 0 0 20px;
|
|
||||||
padding: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
ul.search li {
|
|
||||||
padding: 5px 0 5px 20px;
|
|
||||||
background-image: url(file.png);
|
|
||||||
background-repeat: no-repeat;
|
|
||||||
background-position: 0 7px;
|
|
||||||
}
|
|
||||||
|
|
||||||
ul.search li a {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
ul.search li div.context {
|
|
||||||
color: #888;
|
|
||||||
margin: 2px 0 0 30px;
|
|
||||||
text-align: left;
|
|
||||||
}
|
|
||||||
|
|
||||||
ul.keywordmatches li.goodmatch a {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- index page ------------------------------------------------------------ */
|
|
||||||
|
|
||||||
table.contentstable {
|
|
||||||
width: 90%;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.contentstable p.biglink {
|
|
||||||
line-height: 150%;
|
|
||||||
}
|
|
||||||
|
|
||||||
a.biglink {
|
|
||||||
font-size: 1.3em;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.linkdescr {
|
|
||||||
font-style: italic;
|
|
||||||
padding-top: 5px;
|
|
||||||
font-size: 90%;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- general index --------------------------------------------------------- */
|
|
||||||
|
|
||||||
table.indextable {
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.indextable td {
|
|
||||||
text-align: left;
|
|
||||||
vertical-align: top;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.indextable dl, table.indextable dd {
|
|
||||||
margin-top: 0;
|
|
||||||
margin-bottom: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.indextable tr.pcap {
|
|
||||||
height: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.indextable tr.cap {
|
|
||||||
margin-top: 10px;
|
|
||||||
background-color: #f2f2f2;
|
|
||||||
}
|
|
||||||
|
|
||||||
img.toggler {
|
|
||||||
margin-right: 3px;
|
|
||||||
margin-top: 3px;
|
|
||||||
cursor: pointer;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.modindex-jumpbox {
|
|
||||||
border-top: 1px solid #ddd;
|
|
||||||
border-bottom: 1px solid #ddd;
|
|
||||||
margin: 1em 0 1em 0;
|
|
||||||
padding: 0.4em;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.genindex-jumpbox {
|
|
||||||
border-top: 1px solid #ddd;
|
|
||||||
border-bottom: 1px solid #ddd;
|
|
||||||
margin: 1em 0 1em 0;
|
|
||||||
padding: 0.4em;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- general body styles --------------------------------------------------- */
|
|
||||||
|
|
||||||
a.headerlink {
|
|
||||||
visibility: hidden;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.body p.caption {
|
|
||||||
text-align: inherit;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.body td {
|
|
||||||
text-align: left;
|
|
||||||
}
|
|
||||||
|
|
||||||
.field-list ul {
|
|
||||||
padding-left: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.first {
|
|
||||||
margin-top: 0 !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
p.rubric {
|
|
||||||
margin-top: 30px;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
img.align-left, .figure.align-left, object.align-left {
|
|
||||||
clear: left;
|
|
||||||
float: left;
|
|
||||||
margin-right: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
img.align-right, .figure.align-right, object.align-right {
|
|
||||||
clear: right;
|
|
||||||
float: right;
|
|
||||||
margin-left: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
img.align-center, .figure.align-center, object.align-center {
|
|
||||||
display: block;
|
|
||||||
margin-left: auto;
|
|
||||||
margin-right: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
.align-left {
|
|
||||||
text-align: left;
|
|
||||||
}
|
|
||||||
|
|
||||||
.align-center {
|
|
||||||
text-align: center;
|
|
||||||
}
|
|
||||||
|
|
||||||
.align-right {
|
|
||||||
text-align: right;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- sidebars -------------------------------------------------------------- */
|
|
||||||
|
|
||||||
div.sidebar {
|
|
||||||
margin: 0 0 0.5em 1em;
|
|
||||||
border: 1px solid #ddb;
|
|
||||||
padding: 7px 7px 0 7px;
|
|
||||||
background-color: #ffe;
|
|
||||||
width: 40%;
|
|
||||||
float: right;
|
|
||||||
}
|
|
||||||
|
|
||||||
p.sidebar-title {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- topics ---------------------------------------------------------------- */
|
|
||||||
|
|
||||||
div.topic {
|
|
||||||
border: 1px solid #ccc;
|
|
||||||
padding: 7px 7px 0 7px;
|
|
||||||
margin: 10px 0 10px 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
p.topic-title {
|
|
||||||
font-size: 1.1em;
|
|
||||||
font-weight: bold;
|
|
||||||
margin-top: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- admonitions ----------------------------------------------------------- */
|
|
||||||
|
|
||||||
div.admonition {
|
|
||||||
margin-top: 10px;
|
|
||||||
margin-bottom: 10px;
|
|
||||||
padding: 7px;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.admonition dt {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.admonition dl {
|
|
||||||
margin-bottom: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
p.admonition-title {
|
|
||||||
margin: 0px 10px 5px 0px;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.body p.centered {
|
|
||||||
text-align: center;
|
|
||||||
margin-top: 25px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- tables ---------------------------------------------------------------- */
|
|
||||||
|
|
||||||
table.field-list td, table.field-list th {
|
|
||||||
border: 0 !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.footnote td, table.footnote th {
|
|
||||||
border: 0 !important;
|
|
||||||
}
|
|
||||||
|
|
||||||
th {
|
|
||||||
text-align: left;
|
|
||||||
padding-right: 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.citation {
|
|
||||||
border-left: solid 1px gray;
|
|
||||||
margin-left: 1px;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.citation td {
|
|
||||||
border-bottom: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- other body styles ----------------------------------------------------- */
|
|
||||||
|
|
||||||
ol.arabic {
|
|
||||||
list-style: decimal;
|
|
||||||
}
|
|
||||||
|
|
||||||
ol.loweralpha {
|
|
||||||
list-style: lower-alpha;
|
|
||||||
}
|
|
||||||
|
|
||||||
ol.upperalpha {
|
|
||||||
list-style: upper-alpha;
|
|
||||||
}
|
|
||||||
|
|
||||||
ol.lowerroman {
|
|
||||||
list-style: lower-roman;
|
|
||||||
}
|
|
||||||
|
|
||||||
ol.upperroman {
|
|
||||||
list-style: upper-roman;
|
|
||||||
}
|
|
||||||
|
|
||||||
dd p {
|
|
||||||
margin-top: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
dd ul, dd table {
|
|
||||||
margin-bottom: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
dd {
|
|
||||||
margin-top: 3px;
|
|
||||||
margin-bottom: 10px;
|
|
||||||
margin-left: 30px;
|
|
||||||
}
|
|
||||||
|
|
||||||
dt:target, .highlighted {
|
|
||||||
background-color: #fbe54e;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl.glossary dt {
|
|
||||||
font-weight: bold;
|
|
||||||
font-size: 1.1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.field-list ul {
|
|
||||||
margin: 0;
|
|
||||||
padding-left: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.field-list p {
|
|
||||||
margin: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.refcount {
|
|
||||||
color: #060;
|
|
||||||
}
|
|
||||||
|
|
||||||
.optional {
|
|
||||||
font-size: 1.3em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.versionmodified {
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
.system-message {
|
|
||||||
background-color: #fda;
|
|
||||||
padding: 5px;
|
|
||||||
border: 3px solid red;
|
|
||||||
}
|
|
||||||
|
|
||||||
.footnote:target {
|
|
||||||
background-color: #ffa;
|
|
||||||
}
|
|
||||||
|
|
||||||
.line-block {
|
|
||||||
display: block;
|
|
||||||
margin-top: 1em;
|
|
||||||
margin-bottom: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.line-block .line-block {
|
|
||||||
margin-top: 0;
|
|
||||||
margin-bottom: 0;
|
|
||||||
margin-left: 1.5em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.guilabel, .menuselection {
|
|
||||||
font-family: sans-serif;
|
|
||||||
}
|
|
||||||
|
|
||||||
.accelerator {
|
|
||||||
text-decoration: underline;
|
|
||||||
}
|
|
||||||
|
|
||||||
.classifier {
|
|
||||||
font-style: oblique;
|
|
||||||
}
|
|
||||||
|
|
||||||
abbr, acronym {
|
|
||||||
border-bottom: dotted 1px;
|
|
||||||
cursor: help;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- code displays --------------------------------------------------------- */
|
|
||||||
|
|
||||||
pre {
|
|
||||||
overflow: auto;
|
|
||||||
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
|
||||||
}
|
|
||||||
|
|
||||||
td.linenos pre {
|
|
||||||
padding: 5px 0px;
|
|
||||||
border: 0;
|
|
||||||
background-color: transparent;
|
|
||||||
color: #aaa;
|
|
||||||
}
|
|
||||||
|
|
||||||
.highlight-guess {
|
|
||||||
overflow:auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
.highlight-none {
|
|
||||||
overflow:auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.highlighttable {
|
|
||||||
margin-left: 0.5em;
|
|
||||||
overflow:scroll;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.highlighttable td {
|
|
||||||
padding: 0 0.5em 0 0.5em;
|
|
||||||
}
|
|
||||||
|
|
||||||
tt.descname {
|
|
||||||
background-color: transparent;
|
|
||||||
font-weight: bold;
|
|
||||||
# font-size: 1.2em;
|
|
||||||
}
|
|
||||||
|
|
||||||
tt.descclassname {
|
|
||||||
background-color: transparent;
|
|
||||||
}
|
|
||||||
|
|
||||||
tt.xref, a tt {
|
|
||||||
background-color: transparent;
|
|
||||||
# font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
|
|
||||||
background-color: transparent;
|
|
||||||
}
|
|
||||||
|
|
||||||
.viewcode-link {
|
|
||||||
float: right;
|
|
||||||
}
|
|
||||||
|
|
||||||
.viewcode-back {
|
|
||||||
float: right;
|
|
||||||
font-family: sans-serif;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.viewcode-block:target {
|
|
||||||
margin: -1px -10px;
|
|
||||||
padding: 0 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- math display ---------------------------------------------------------- */
|
|
||||||
|
|
||||||
img.math {
|
|
||||||
vertical-align: middle;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.body div.math p {
|
|
||||||
text-align: center;
|
|
||||||
}
|
|
||||||
|
|
||||||
span.eqno {
|
|
||||||
float: right;
|
|
||||||
}
|
|
||||||
|
|
||||||
/* -- printout stylesheet --------------------------------------------------- */
|
|
||||||
|
|
||||||
@media print {
|
|
||||||
div.document,
|
|
||||||
div.documentwrapper,
|
|
||||||
div.bodywrapper {
|
|
||||||
margin: 0 !important;
|
|
||||||
width: 100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.sphinxsidebar,
|
|
||||||
div.related,
|
|
||||||
div.footer,
|
|
||||||
#top-link {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
160
doc/_static/broxygen-extra.css
vendored
160
doc/_static/broxygen-extra.css
vendored
|
|
@ -1,160 +0,0 @@
|
||||||
|
|
||||||
a.toc-backref {
|
|
||||||
color: #333;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1, h2, h3, h4, h5, h6,
|
|
||||||
h1 a, h2 a, h3 a, h4 a, h5 a, h6 a {
|
|
||||||
padding:0 0 0px 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
ul {
|
|
||||||
padding-bottom: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1 {
|
|
||||||
font-weight: bold;
|
|
||||||
font-size: 32px;
|
|
||||||
line-height:32px;
|
|
||||||
text-align: center;
|
|
||||||
padding-top: 3px;
|
|
||||||
margin-bottom: 30px;
|
|
||||||
font-family: Palatino,'Palatino Linotype',Georgia,serif;;
|
|
||||||
color: #000;
|
|
||||||
border-bottom: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
th.field-name
|
|
||||||
{
|
|
||||||
white-space:nowrap;
|
|
||||||
}
|
|
||||||
|
|
||||||
h2 {
|
|
||||||
margin-top: 50px;
|
|
||||||
padding-bottom: 5px;
|
|
||||||
margin-bottom: 30px;
|
|
||||||
border-bottom: 1px solid;
|
|
||||||
border-color: #aaa;
|
|
||||||
font-style: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.section h3 {
|
|
||||||
font-style: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
h3 {
|
|
||||||
font-size: 20px;
|
|
||||||
margin-top: 40px;
|
|
||||||
margin-bottom: 0¡px;
|
|
||||||
font-weight: bold;
|
|
||||||
font-style: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
h3.widgettitle {
|
|
||||||
font-style: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
h4 {
|
|
||||||
font-size:18px;
|
|
||||||
font-style: normal;
|
|
||||||
margin-bottom: 0em;
|
|
||||||
margin-top: 40px;
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
h5 {
|
|
||||||
font-size:16px;
|
|
||||||
}
|
|
||||||
|
|
||||||
h6 {
|
|
||||||
font-size:15px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.toc-backref {
|
|
||||||
color: #333;
|
|
||||||
}
|
|
||||||
|
|
||||||
.contents ul {
|
|
||||||
padding-bottom: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl.namespace {
|
|
||||||
display: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl dt {
|
|
||||||
font-weight: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.docutils tbody {
|
|
||||||
margin: 1em 1em 1em 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.docutils td {
|
|
||||||
padding: 5pt 5pt 5pt 5pt;
|
|
||||||
font-size: 14px;
|
|
||||||
border-left: 0;
|
|
||||||
border-right: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl pre {
|
|
||||||
font-size: 14px;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.docutils th {
|
|
||||||
padding: 5pt 5pt 5pt 5pt;
|
|
||||||
font-size: 14px;
|
|
||||||
font-style: normal;
|
|
||||||
border-left: 0;
|
|
||||||
border-right: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.docutils tr:first-child td {
|
|
||||||
#border-top: 1px solid #aaa;
|
|
||||||
}
|
|
||||||
|
|
||||||
.download {
|
|
||||||
font-family:"Courier New", Courier, mono;
|
|
||||||
font-weight: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
dt:target, .highlighted {
|
|
||||||
background-color: #ccc;
|
|
||||||
}
|
|
||||||
|
|
||||||
p {
|
|
||||||
padding-bottom: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
p.last {
|
|
||||||
margin-bottom: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl {
|
|
||||||
padding: 1em 1em 1em 1em;
|
|
||||||
background: #fffff0;
|
|
||||||
border: 1px solid #aaa;
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
dl {
|
|
||||||
margin-bottom: 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
table.docutils {
|
|
||||||
background: #fffff0;
|
|
||||||
border-collapse: collapse;
|
|
||||||
border: 1px solid #ddd;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl table.docutils {
|
|
||||||
border: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
table.docutils dl {
|
|
||||||
border: 1px dashed #666;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
0
doc/_static/broxygen-extra.js
vendored
0
doc/_static/broxygen-extra.js
vendored
483
doc/_static/broxygen.css
vendored
483
doc/_static/broxygen.css
vendored
|
|
@ -1,483 +0,0 @@
|
||||||
/* Automatically generated. Do not edit. */
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#bro-main, #bro-standalone-main {
|
|
||||||
padding: 0 0 0 0;
|
|
||||||
position:relative;
|
|
||||||
z-index:1;
|
|
||||||
}
|
|
||||||
|
|
||||||
#bro-main {
|
|
||||||
margin-bottom: 2em;
|
|
||||||
}
|
|
||||||
|
|
||||||
#bro-standalone-main {
|
|
||||||
margin-bottom: 0em;
|
|
||||||
padding-left: 50px;
|
|
||||||
padding-right: 50px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#bro-outer {
|
|
||||||
color: #333;
|
|
||||||
background: #ffffff;
|
|
||||||
}
|
|
||||||
|
|
||||||
#bro-title {
|
|
||||||
font-weight: bold;
|
|
||||||
font-size: 32px;
|
|
||||||
line-height:32px;
|
|
||||||
text-align: center;
|
|
||||||
padding-top: 3px;
|
|
||||||
margin-bottom: 30px;
|
|
||||||
font-family: Palatino,'Palatino Linotype',Georgia,serif;;
|
|
||||||
color: #000;
|
|
||||||
}
|
|
||||||
|
|
||||||
.opening:first-letter {
|
|
||||||
font-size: 24px;
|
|
||||||
font-weight: bold;
|
|
||||||
letter-spacing: 0.05em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.opening {
|
|
||||||
font-size: 17px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.version {
|
|
||||||
text-align: right;
|
|
||||||
font-size: 12px;
|
|
||||||
color: #aaa;
|
|
||||||
line-height: 0;
|
|
||||||
height: 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.git-info-version {
|
|
||||||
position: relative;
|
|
||||||
height: 2em;
|
|
||||||
top: -1em;
|
|
||||||
color: #ccc;
|
|
||||||
float: left;
|
|
||||||
font-size: 12px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.git-info-date {
|
|
||||||
position: relative;
|
|
||||||
height: 2em;
|
|
||||||
top: -1em;
|
|
||||||
color: #ccc;
|
|
||||||
float: right;
|
|
||||||
font-size: 12px;
|
|
||||||
}
|
|
||||||
|
|
||||||
body {
|
|
||||||
font-family:Arial, Helvetica, sans-serif;
|
|
||||||
font-size:15px;
|
|
||||||
line-height:22px;
|
|
||||||
color: #333;
|
|
||||||
margin: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1, h2, h3, h4, h5, h6,
|
|
||||||
h1 a, h2 a, h3 a, h4 a, h5 a, h6 a {
|
|
||||||
padding:0 0 20px 0;
|
|
||||||
font-weight:bold;
|
|
||||||
text-decoration:none;
|
|
||||||
}
|
|
||||||
|
|
||||||
div.section h3, div.section h4, div.section h5, div.section h6 {
|
|
||||||
font-style: italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1, h2 {
|
|
||||||
font-size:27px;
|
|
||||||
letter-spacing:-1px;
|
|
||||||
}
|
|
||||||
|
|
||||||
h3 {
|
|
||||||
margin-top: 1em;
|
|
||||||
font-size:18px;
|
|
||||||
}
|
|
||||||
|
|
||||||
h4 {
|
|
||||||
font-size:16px;
|
|
||||||
}
|
|
||||||
|
|
||||||
h5 {
|
|
||||||
font-size:15px;
|
|
||||||
}
|
|
||||||
|
|
||||||
h6 {
|
|
||||||
font-size:12px;
|
|
||||||
}
|
|
||||||
|
|
||||||
p {
|
|
||||||
padding:0 0 20px 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
hr {
|
|
||||||
background:none;
|
|
||||||
height:1px;
|
|
||||||
line-height:1px;
|
|
||||||
border:0;
|
|
||||||
margin:0 0 20px 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
ul, ol {
|
|
||||||
margin:0 20px 20px 0;
|
|
||||||
padding-left:40px;
|
|
||||||
}
|
|
||||||
|
|
||||||
ul.simple, ol.simple {
|
|
||||||
margin:0 0px 0px 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
blockquote {
|
|
||||||
margin:0 0 0 40px;
|
|
||||||
}
|
|
||||||
|
|
||||||
strong, dfn {
|
|
||||||
font-weight:bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
em, dfn {
|
|
||||||
font-style:italic;
|
|
||||||
}
|
|
||||||
|
|
||||||
sup, sub {
|
|
||||||
line-height:0;
|
|
||||||
}
|
|
||||||
|
|
||||||
pre, code {
|
|
||||||
white-space: pre;
|
|
||||||
overflow: auto;
|
|
||||||
margin-left: 0.25em;
|
|
||||||
margin-right: 0.25em;
|
|
||||||
word-wrap: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
pre, code, tt {
|
|
||||||
font-family:"Courier New", Courier, mono;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl {
|
|
||||||
margin: 0 0 20px 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
dl dt {
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
li dl dt {
|
|
||||||
font-weight: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
dd {
|
|
||||||
margin:0 0 20px 20px;
|
|
||||||
}
|
|
||||||
|
|
||||||
small {
|
|
||||||
font-size:75%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.small-text {
|
|
||||||
font-size:75%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.align-center {
|
|
||||||
display: block;
|
|
||||||
margin-left: auto;
|
|
||||||
margin-right: auto;
|
|
||||||
}
|
|
||||||
|
|
||||||
a:link,
|
|
||||||
a:visited,
|
|
||||||
a:active
|
|
||||||
{
|
|
||||||
color: #2a85a7;
|
|
||||||
}
|
|
||||||
|
|
||||||
a:hover
|
|
||||||
{
|
|
||||||
color:#c24444;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1, h2, h3, h4, h5, h6,
|
|
||||||
h1 a, h2 a, h3 a, h4 a, h5 a, h6 a
|
|
||||||
{
|
|
||||||
color: #333;
|
|
||||||
}
|
|
||||||
|
|
||||||
hr {
|
|
||||||
border-bottom:1px solid #ddd;
|
|
||||||
}
|
|
||||||
|
|
||||||
pre {
|
|
||||||
color: #333;
|
|
||||||
background: #FFFAE2;
|
|
||||||
padding: 7px 5px 3px 5px;
|
|
||||||
margin-bottom: 25px;
|
|
||||||
margin-top: 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
ul {
|
|
||||||
padding-bottom: 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1, h2 {
|
|
||||||
margin-top: 30px;
|
|
||||||
}
|
|
||||||
|
|
||||||
h1 {
|
|
||||||
margin-bottom: 50px;
|
|
||||||
margin-bottom: 20px;
|
|
||||||
padding-bottom: 5px;
|
|
||||||
border-bottom: 1px solid;
|
|
||||||
border-color: #aaa;
|
|
||||||
}
|
|
||||||
|
|
||||||
h2 {
|
|
||||||
font-size: 24px;
|
|
||||||
}
|
|
||||||
|
|
||||||
pre {
|
|
||||||
-moz-box-shadow:0 0 6px #ddd;
|
|
||||||
-webkit-box-shadow:0 0 6px #ddd;
|
|
||||||
box-shadow:0 0 6px #ddd;
|
|
||||||
}
|
|
||||||
|
|
||||||
a {
|
|
||||||
text-decoration:none;
|
|
||||||
}
|
|
||||||
|
|
||||||
p {
|
|
||||||
padding-bottom: 15px;
|
|
||||||
}
|
|
||||||
|
|
||||||
p, dd, li {
|
|
||||||
text-align: justify;
|
|
||||||
}
|
|
||||||
|
|
||||||
li {
|
|
||||||
margin-bottom: 5px;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#footer .widget_links ul a,
|
|
||||||
#footer .widget_links ol a
|
|
||||||
{
|
|
||||||
color: #ddd;
|
|
||||||
}
|
|
||||||
|
|
||||||
#footer .widget_links ul a:hover,
|
|
||||||
#footer .widget_links ol a:hover
|
|
||||||
{
|
|
||||||
color:#c24444;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
#footer .widget li {
|
|
||||||
padding-bottom:10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#footer .widget_links li {
|
|
||||||
padding-bottom:1px;
|
|
||||||
}
|
|
||||||
|
|
||||||
#footer .widget li:last-child {
|
|
||||||
padding-bottom:0;
|
|
||||||
}
|
|
||||||
|
|
||||||
#footer .widgettitle {
|
|
||||||
color: #ddd;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
.widget {
|
|
||||||
margin:0 0 40px 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.widget, .widgettitle {
|
|
||||||
font-size:12px;
|
|
||||||
line-height:18px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.widgettitle {
|
|
||||||
font-weight:bold;
|
|
||||||
text-transform:uppercase;
|
|
||||||
padding:0 0 10px 0;
|
|
||||||
margin:0 0 20px 0;
|
|
||||||
line-height:100%;
|
|
||||||
}
|
|
||||||
|
|
||||||
.widget UL, .widget OL {
|
|
||||||
list-style-type:none;
|
|
||||||
margin:0;
|
|
||||||
padding:0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.widget p {
|
|
||||||
padding:0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.widget li {
|
|
||||||
padding-bottom:10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.widget a {
|
|
||||||
text-decoration:none;
|
|
||||||
}
|
|
||||||
|
|
||||||
#bro-main .widgettitle,
|
|
||||||
{
|
|
||||||
color: #333;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
.widget img.left {
|
|
||||||
padding:5px 10px 10px 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
.widget img.right {
|
|
||||||
padding:5px 0 10px 10px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.ads .widgettitle {
|
|
||||||
margin-right:16px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.widget {
|
|
||||||
margin-left: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.widgettitle {
|
|
||||||
color: #333;
|
|
||||||
}
|
|
||||||
|
|
||||||
.widgettitle {
|
|
||||||
border-bottom:1px solid #ddd;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
.sidebar-toc ul li {
|
|
||||||
padding-bottom: 0px;
|
|
||||||
text-align: left;
|
|
||||||
list-style-type: square;
|
|
||||||
list-style-position: inside;
|
|
||||||
padding-left: 1em;
|
|
||||||
text-indent: -1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sidebar-toc ul li li {
|
|
||||||
margin-left: 1em;
|
|
||||||
margin-bottom: 0px;
|
|
||||||
list-style-type: square;
|
|
||||||
}
|
|
||||||
|
|
||||||
.sidebar-toc ul li li a {
|
|
||||||
font-size: 8pt;
|
|
||||||
}
|
|
||||||
|
|
||||||
.contents {
|
|
||||||
padding: 10px;
|
|
||||||
background: #FFFAE2;
|
|
||||||
margin: 20px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.topic-title {
|
|
||||||
font-size: 20px;
|
|
||||||
font-weight: bold;
|
|
||||||
padding: 0px 0px 5px 0px;
|
|
||||||
text-align: center;
|
|
||||||
padding-top: .5em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.contents li {
|
|
||||||
margin-bottom: 0px;
|
|
||||||
list-style-type: square;
|
|
||||||
}
|
|
||||||
|
|
||||||
.contents ul ul li {
|
|
||||||
margin-left: 0px;
|
|
||||||
padding-left: 0px;
|
|
||||||
padding-top: 0em;
|
|
||||||
font-size: 90%;
|
|
||||||
list-style-type: square;
|
|
||||||
font-weight: normal;
|
|
||||||
}
|
|
||||||
|
|
||||||
.contents ul ul ul li {
|
|
||||||
list-style-type: none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.contents ul ul ul ul li {
|
|
||||||
display:none;
|
|
||||||
}
|
|
||||||
|
|
||||||
.contents ul li {
|
|
||||||
padding-top: 1em;
|
|
||||||
list-style-type: none;
|
|
||||||
font-weight: bold;
|
|
||||||
}
|
|
||||||
|
|
||||||
.contents ul {
|
|
||||||
margin-left: 0px;
|
|
||||||
padding-left: 2em;
|
|
||||||
margin: 0px 0px 0px 0px;
|
|
||||||
}
|
|
||||||
|
|
||||||
.note, .warning, .error {
|
|
||||||
margin-left: 2em;
|
|
||||||
margin-right: 2em;
|
|
||||||
margin-top: 1.5em;
|
|
||||||
margin-bottom: 1.5em;
|
|
||||||
padding: 0.5em 1em 0.5em 1em;
|
|
||||||
overflow: auto;
|
|
||||||
border-left: solid 3px #aaa;
|
|
||||||
font-size: 15px;
|
|
||||||
color: #333;
|
|
||||||
}
|
|
||||||
|
|
||||||
.admonition p {
|
|
||||||
margin-left: 1em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.admonition-title {
|
|
||||||
font-size: 16px;
|
|
||||||
font-weight: bold;
|
|
||||||
color: #000;
|
|
||||||
padding-bottom: 0em;
|
|
||||||
margin-bottom: .5em;
|
|
||||||
margin-top: 0em;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btest-cmd .hll {
|
|
||||||
font-weight: bold;
|
|
||||||
background: #FFFAE2;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btest-include .hll {
|
|
||||||
display: block;
|
|
||||||
text-align: center;
|
|
||||||
font-family: Palatino;
|
|
||||||
background: #FFFAE2;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btest-include .hll * {
|
|
||||||
color: #aaa;
|
|
||||||
}
|
|
||||||
|
|
||||||
.linenodiv pre {
|
|
||||||
margin-left: 0px;
|
|
||||||
margin-right: 0px;
|
|
||||||
width: 1.5em;
|
|
||||||
text-align: right;
|
|
||||||
background: #000;
|
|
||||||
}
|
|
||||||
|
|
||||||
.btest-cmd .code pre, .btest-include .code pre {
|
|
||||||
margin-left: 0px;
|
|
||||||
}
|
|
||||||
BIN
doc/_static/logo-bro.png
vendored
BIN
doc/_static/logo-bro.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB |
58
doc/_static/pygments.css
vendored
58
doc/_static/pygments.css
vendored
|
|
@ -1,58 +0,0 @@
|
||||||
.hll { background-color: #ffffcc }
|
|
||||||
.c { color: #aaaaaa; font-style: italic } /* Comment */
|
|
||||||
.err { color: #F00000; background-color: #F0A0A0 } /* Error */
|
|
||||||
.k { color: #0000aa } /* Keyword */
|
|
||||||
.cm { color: #aaaaaa; font-style: italic } /* Comment.Multiline */
|
|
||||||
.cp { color: #4c8317 } /* Comment.Preproc */
|
|
||||||
.c1 { color: #aaaaaa; font-style: italic } /* Comment.Single */
|
|
||||||
.cs { color: #0000aa; font-style: italic } /* Comment.Special */
|
|
||||||
.gd { color: #aa0000 } /* Generic.Deleted */
|
|
||||||
.ge { font-style: italic } /* Generic.Emph */
|
|
||||||
.gr { color: #aa0000 } /* Generic.Error */
|
|
||||||
.gh { color: #000080; font-weight: bold } /* Generic.Heading */
|
|
||||||
.gi { color: #00aa00 } /* Generic.Inserted */
|
|
||||||
.go { color: #888888 } /* Generic.Output */
|
|
||||||
.gp { color: #555555 } /* Generic.Prompt */
|
|
||||||
.gs { font-weight: bold } /* Generic.Strong */
|
|
||||||
.gu { color: #800080; font-weight: bold } /* Generic.Subheading */
|
|
||||||
.gt { color: #aa0000 } /* Generic.Traceback */
|
|
||||||
.kc { color: #0000aa } /* Keyword.Constant */
|
|
||||||
.kd { color: #0000aa } /* Keyword.Declaration */
|
|
||||||
.kn { color: #0000aa } /* Keyword.Namespace */
|
|
||||||
.kp { color: #0000aa } /* Keyword.Pseudo */
|
|
||||||
.kr { color: #0000aa } /* Keyword.Reserved */
|
|
||||||
.kt { color: #00aaaa } /* Keyword.Type */
|
|
||||||
.m { color: #009999 } /* Literal.Number */
|
|
||||||
.s { color: #aa5500 } /* Literal.String */
|
|
||||||
.na { color: #1e90ff } /* Name.Attribute */
|
|
||||||
.nb { color: #00aaaa } /* Name.Builtin */
|
|
||||||
.nc { color: #00aa00; text-decoration: underline } /* Name.Class */
|
|
||||||
.no { color: #aa0000 } /* Name.Constant */
|
|
||||||
.nd { color: #888888 } /* Name.Decorator */
|
|
||||||
.ni { color: #800000; font-weight: bold } /* Name.Entity */
|
|
||||||
.nf { color: #00aa00 } /* Name.Function */
|
|
||||||
.nn { color: #00aaaa; text-decoration: underline } /* Name.Namespace */
|
|
||||||
.nt { color: #1e90ff; font-weight: bold } /* Name.Tag */
|
|
||||||
.nv { color: #aa0000 } /* Name.Variable */
|
|
||||||
.ow { color: #0000aa } /* Operator.Word */
|
|
||||||
.w { color: #bbbbbb } /* Text.Whitespace */
|
|
||||||
.mf { color: #009999 } /* Literal.Number.Float */
|
|
||||||
.mh { color: #009999 } /* Literal.Number.Hex */
|
|
||||||
.mi { color: #009999 } /* Literal.Number.Integer */
|
|
||||||
.mo { color: #009999 } /* Literal.Number.Oct */
|
|
||||||
.sb { color: #aa5500 } /* Literal.String.Backtick */
|
|
||||||
.sc { color: #aa5500 } /* Literal.String.Char */
|
|
||||||
.sd { color: #aa5500 } /* Literal.String.Doc */
|
|
||||||
.s2 { color: #aa5500 } /* Literal.String.Double */
|
|
||||||
.se { color: #aa5500 } /* Literal.String.Escape */
|
|
||||||
.sh { color: #aa5500 } /* Literal.String.Heredoc */
|
|
||||||
.si { color: #aa5500 } /* Literal.String.Interpol */
|
|
||||||
.sx { color: #aa5500 } /* Literal.String.Other */
|
|
||||||
.sr { color: #009999 } /* Literal.String.Regex */
|
|
||||||
.s1 { color: #aa5500 } /* Literal.String.Single */
|
|
||||||
.ss { color: #0000aa } /* Literal.String.Symbol */
|
|
||||||
.bp { color: #00aaaa } /* Name.Builtin.Pseudo */
|
|
||||||
.vc { color: #aa0000 } /* Name.Variable.Class */
|
|
||||||
.vg { color: #aa0000 } /* Name.Variable.Global */
|
|
||||||
.vi { color: #aa0000 } /* Name.Variable.Instance */
|
|
||||||
.il { color: #009999 } /* Literal.Number.Integer.Long */
|
|
||||||
15
doc/_templates/breadcrumbs.html
vendored
Normal file
15
doc/_templates/breadcrumbs.html
vendored
Normal file
|
|
@ -0,0 +1,15 @@
|
||||||
|
{% extends "!breadcrumbs.html" %}
|
||||||
|
|
||||||
|
{% block breadcrumbs_aside %}
|
||||||
|
<li class="wy-breadcrumbs-aside">
|
||||||
|
{% if pagename != "search" %}
|
||||||
|
{% if display_github %}
|
||||||
|
{% if github_version == "master" %}
|
||||||
|
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="fa fa-github"> {{ _('Edit on GitHub') }}</a>
|
||||||
|
{% endif %}
|
||||||
|
{% elif show_source and has_source and sourcename %}
|
||||||
|
<a href="{{ pathto('_sources/' + sourcename, true)|e }}" rel="nofollow"> {{ _('View page source') }}</a>
|
||||||
|
{% endif %}
|
||||||
|
{% endif %}
|
||||||
|
</li>
|
||||||
|
{% endblock %}
|
||||||
116
doc/_templates/layout.html
vendored
116
doc/_templates/layout.html
vendored
|
|
@ -1,113 +1,7 @@
|
||||||
{% extends "!layout.html" %}
|
{% extends "!layout.html" %}
|
||||||
|
|
||||||
{% block extrahead %}
|
{% if READTHEDOCS and current_version %}
|
||||||
<link rel="stylesheet" type="text/css" href="{{ pathto('_static/broxygen.css', 1) }}"></script>
|
{% if current_version == "latest" or current_version == "stable" %}
|
||||||
<link rel="stylesheet" type="text/css" href="{{ pathto('_static/960.css', 1) }}"></script>
|
{% set current_version = current_version ~ " (" ~ version ~ ")" %}
|
||||||
<link rel="stylesheet" type="text/css" href="{{ pathto('_static/pygments.css', 1) }}"></script>
|
{% endif %}
|
||||||
<link rel="stylesheet" type="text/css" href="{{ pathto('_static/broxygen-extra.css', 1) }}"></script>
|
{% endif %}
|
||||||
|
|
||||||
<script type="text/javascript" src="{{ pathto('_static/broxygen-extra.js', 1) }}"></script>
|
|
||||||
{% endblock %}
|
|
||||||
|
|
||||||
{% block header %}
|
|
||||||
<iframe src="https://www.bro.org/frames/header-no-logo.html" width="100%" height="100px" frameborder="0" marginheight="0" scrolling="no" marginwidth="0">
|
|
||||||
</iframe>
|
|
||||||
{% endblock %}
|
|
||||||
|
|
||||||
{% block relbar2 %}{% endblock %}
|
|
||||||
{% block relbar1 %}{% endblock %}
|
|
||||||
|
|
||||||
{% block content %}
|
|
||||||
|
|
||||||
<div id="bro-main" class="clearfix">
|
|
||||||
<div class="container_12">
|
|
||||||
|
|
||||||
<div class="grid_9">
|
|
||||||
|
|
||||||
<div>
|
|
||||||
{{ relbar() }}
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="body">
|
|
||||||
{% block body %}
|
|
||||||
{% endblock %}
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<!-- Sidebar -->
|
|
||||||
<div class="grid_3 omega">
|
|
||||||
|
|
||||||
<div>
|
|
||||||
<img id="logo" src="{{pathto('_static/logo-bro.png', 1)}}" alt="Logo" />
|
|
||||||
</div>
|
|
||||||
<br />
|
|
||||||
|
|
||||||
|
|
||||||
<div class="widget sidebar-toc">
|
|
||||||
<h3 class="widgettitle">
|
|
||||||
Table of Contents
|
|
||||||
</h3>
|
|
||||||
<p>
|
|
||||||
<!-- <ul id="sidebar-toc"></ul> -->
|
|
||||||
<ul>{{toc}}</ul>
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
{% if next %}
|
|
||||||
<div class="widget">
|
|
||||||
<h3 class="widgettitle">
|
|
||||||
Next Page
|
|
||||||
</h3>
|
|
||||||
<p>
|
|
||||||
<a href="{{ next.link|e }}">{{ next.title }}</a>
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% if prev %}
|
|
||||||
<div class="widget">
|
|
||||||
<h3 class="widgettitle">
|
|
||||||
Previous Page
|
|
||||||
</h3>
|
|
||||||
<p>
|
|
||||||
<a href="{{ prev.link|e }}">{{ prev.title }}</a>
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{%- if pagename != "search" %}
|
|
||||||
<div id="searchbox" style="display: none" class="widget">
|
|
||||||
<h3 class="widgettitle">{{ _('Search') }}</h3>
|
|
||||||
<form class="search" action="{{ pathto('search') }}" method="get">
|
|
||||||
<input type="text" name="q" />
|
|
||||||
<input type="submit" value="{{ _('Search') }}" />
|
|
||||||
<input type="hidden" name="check_keywords" value="yes" />
|
|
||||||
<input type="hidden" name="area" value="default" />
|
|
||||||
</form>
|
|
||||||
</div>
|
|
||||||
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
||||||
{%- endif %}
|
|
||||||
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="container_12">
|
|
||||||
<div class="grid_12 alpha omega">
|
|
||||||
<div class="center">
|
|
||||||
<small>
|
|
||||||
Copyright {{ copyright }}.
|
|
||||||
Last updated on {{ last_updated }}.
|
|
||||||
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.
|
|
||||||
</small>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
{% endblock %}
|
|
||||||
|
|
||||||
{% block footer %}
|
|
||||||
<iframe src="https://www.bro.org/frames/footer.html" width="100%" height="420px" frameborder="0" marginheight="0" scrolling="no" marginwidth="0">
|
|
||||||
</iframe>
|
|
||||||
{% endblock %}
|
|
||||||
|
|
|
||||||
41
doc/conf.py
41
doc/conf.py
|
|
@ -1,6 +1,6 @@
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
#
|
#
|
||||||
# Bro documentation build configuration file, created by sphinx-quickstart
|
# Zeek documentation build configuration file, created by sphinx-quickstart
|
||||||
#
|
#
|
||||||
# This file is execfile()d with the current directory set to its containing dir.
|
# This file is execfile()d with the current directory set to its containing dir.
|
||||||
#
|
#
|
||||||
|
|
@ -29,7 +29,7 @@ sys.path.insert(0, os.path.abspath('ext'))
|
||||||
extensions += ['bro', 'rst_directive', 'sphinx.ext.todo']
|
extensions += ['bro', 'rst_directive', 'sphinx.ext.todo']
|
||||||
|
|
||||||
# Add any paths that contain templates here, relative to this directory.
|
# Add any paths that contain templates here, relative to this directory.
|
||||||
templates_path = ['_templates', '_static']
|
templates_path = ['_templates']
|
||||||
|
|
||||||
# The suffix of source filenames.
|
# The suffix of source filenames.
|
||||||
source_suffix = '.rst'
|
source_suffix = '.rst'
|
||||||
|
|
@ -41,8 +41,8 @@ source_suffix = '.rst'
|
||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = u'Bro'
|
project = u'Zeek'
|
||||||
copyright = u'2018, The Bro Project'
|
copyright = u'2018, The Zeek Project'
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
# |version| and |release|, also used in various other places throughout the
|
# |version| and |release|, also used in various other places throughout the
|
||||||
|
|
@ -96,21 +96,30 @@ highlight_language = 'none'
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
# a list of builtin themes.
|
# a list of builtin themes.
|
||||||
html_theme = 'basic'
|
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
||||||
|
|
||||||
|
if not on_rtd:
|
||||||
|
# only import and set the theme if we're building docs locally
|
||||||
|
import sphinx_rtd_theme
|
||||||
|
html_theme = 'sphinx_rtd_theme'
|
||||||
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||||||
|
|
||||||
html_last_updated_fmt = '%B %d, %Y'
|
html_last_updated_fmt = '%B %d, %Y'
|
||||||
|
|
||||||
# Theme options are theme-specific and customize the look and feel of a theme
|
# Theme options are theme-specific and customize the look and feel of a theme
|
||||||
# further. For a list of options available for each theme, see the
|
# further. For a list of options available for each theme, see the
|
||||||
# documentation.
|
# documentation.
|
||||||
html_theme_options = { }
|
html_theme_options = {
|
||||||
|
'collapse_navigation': False,
|
||||||
|
'display_version': True,
|
||||||
|
}
|
||||||
|
|
||||||
# Add any paths that contain custom themes here, relative to this directory.
|
# Add any paths that contain custom themes here, relative to this directory.
|
||||||
#html_theme_path = []
|
#html_theme_path = []
|
||||||
|
|
||||||
# The name for this set of Sphinx documents. If None, it defaults to
|
# The name for this set of Sphinx documents. If None, it defaults to
|
||||||
# "<project> v<release> Documentation".
|
# "<project> v<release> Documentation".
|
||||||
#html_title = None
|
html_title = u'Zeek User Manual v' + release
|
||||||
|
|
||||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||||
#html_short_title = None
|
#html_short_title = None
|
||||||
|
|
@ -127,7 +136,7 @@ html_theme_options = { }
|
||||||
# Add any paths that contain custom static files (such as style sheets) here,
|
# Add any paths that contain custom static files (such as style sheets) here,
|
||||||
# relative to this directory. They are copied after the builtin static files,
|
# relative to this directory. They are copied after the builtin static files,
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
html_static_path = ['_static']
|
#html_static_path = ['_static']
|
||||||
|
|
||||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||||
# using the given strftime format.
|
# using the given strftime format.
|
||||||
|
|
@ -138,9 +147,9 @@ html_static_path = ['_static']
|
||||||
#html_use_smartypants = True
|
#html_use_smartypants = True
|
||||||
|
|
||||||
# Custom sidebar templates, maps document names to template names.
|
# Custom sidebar templates, maps document names to template names.
|
||||||
html_sidebars = {
|
#html_sidebars = {
|
||||||
'**': ['localtoc.html', 'sourcelink.html', 'searchbox.html'],
|
#'**': ['localtoc.html', 'sourcelink.html', 'searchbox.html'],
|
||||||
}
|
#}
|
||||||
|
|
||||||
# Additional templates that should be rendered to pages, maps page names to
|
# Additional templates that should be rendered to pages, maps page names to
|
||||||
# template names.
|
# template names.
|
||||||
|
|
@ -173,7 +182,7 @@ html_sidebars = {
|
||||||
#html_file_suffix = None
|
#html_file_suffix = None
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = 'Broxygen'
|
htmlhelp_basename = 'bro-doc'
|
||||||
|
|
||||||
# -- Options for LaTeX output --------------------------------------------------
|
# -- Options for LaTeX output --------------------------------------------------
|
||||||
|
|
||||||
|
|
@ -186,8 +195,8 @@ htmlhelp_basename = 'Broxygen'
|
||||||
# Grouping the document tree into LaTeX files. List of tuples
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
('index', 'Bro.tex', u'Bro Documentation',
|
('index', 'Zeek.tex', u'Zeek Documentation',
|
||||||
u'The Bro Project', 'manual'),
|
u'The Zeek Project', 'manual'),
|
||||||
]
|
]
|
||||||
|
|
||||||
# The name of an image file (relative to this directory) to place at the top of
|
# The name of an image file (relative to this directory) to place at the top of
|
||||||
|
|
@ -218,8 +227,8 @@ latex_documents = [
|
||||||
# One entry per manual page. List of tuples
|
# One entry per manual page. List of tuples
|
||||||
# (source start file, name, description, authors, manual section).
|
# (source start file, name, description, authors, manual section).
|
||||||
man_pages = [
|
man_pages = [
|
||||||
('index', 'bro', u'Bro Documentation',
|
('index', 'bro', u'Zeek Documentation',
|
||||||
[u'The Bro Project'], 1)
|
[u'The Zeek Project'], 1)
|
||||||
]
|
]
|
||||||
|
|
||||||
# -- Options for todo plugin --------------------------------------------
|
# -- Options for todo plugin --------------------------------------------
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue