Skip to content

Commit 845f706

Browse files
committed
Change submodule to include slightly different styling, so newly
added ToC depth will render nicely.
1 parent 3941a5b commit 845f706

File tree

4 files changed

+9
-37
lines changed

4 files changed

+9
-37
lines changed

.gitmodules

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[submodule "docs/source/_themes/mozilla"]
2+
path = docs/source/_themes/mozilla
3+
url = https://github.com/rafrombrc/mozilla-sphinx-theme.git
4+
branch = heka

docs/source/config/inputs/index_noref.rst

+3-35
Original file line numberDiff line numberDiff line change
@@ -3,41 +3,9 @@
33
Inputs
44
======
55

6-
Common Input Parameters
7-
=======================
8-
9-
.. versionadded:: 0.9
10-
11-
There are some configuration options that are universally available to all
12-
Heka input plugins. These will be consumed by Heka itself when Heka
13-
initializes the plugin and do not need to be handled by the plugin-specific
14-
initialization code.
15-
16-
- decoder (string, optional):
17-
Decoder to be used by the input. This should refer to the name of a
18-
registered decoder plugin configuration. If supplied, messages will be
19-
decoded before being passed on to the router when the InputRunner's
20-
`Deliver` method is called.
21-
- synchronous_decode (bool, optional):
22-
If `synchronous_decode` is false, then any specified decoder plugin will
23-
be run by a DecoderRunner in its own goroutine and messages will be passed
24-
in to the decoder over a channel, freeing the input to start processing
25-
the next chunk of incoming or available data. If true, then any decoding
26-
will happen synchronously and message delivery will not return control to
27-
the input until after decoding has completed. Defaults to false.
28-
- send_decode_failures (bool, optional):
29-
If false, then if an attempt to decode a message fails then Heka will log
30-
an error message and then drop the message. If true, then in addition to
31-
logging an error message, decode failure will cause the original,
32-
undecoded message to be tagged with a `decode_failure` field (set to true)
33-
and delivered to the router for possible further processing.
34-
- splitter (string, optional)
35-
Splitter to be used by the input. This should refer to the name of a
36-
registered splitter plugin configuration. It specifies how the input
37-
should split the incoming data stream into individual records prior to
38-
decoding and/or injection to the router. Typically defaults to
39-
"NullSplitter", although certain inputs override this with a different
40-
default value.
6+
.. include:: /config/inputs/index.rst
7+
:start-line: 9
8+
:end-line: 44
419

4210
.. include:: /config/inputs/amqp.rst
4311
:start-line: 1

docs/source/config/inputs/logstreamer.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _config_logstreamer_input:
22

3-
Log Streamer Input
3+
Logstreamer Input
44
==================
55

66
.. versionadded:: 0.5

docs/source/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ hekad Command Line Options
139139
Contents:
140140

141141
.. toctree::
142-
:maxdepth: 2
142+
:maxdepth: 3
143143

144144
installing
145145
getting_started

0 commit comments

Comments
 (0)