From 845f70626bcb908e01afc54cbc079f36e3b274d0 Mon Sep 17 00:00:00 2001 From: Rob Miller Date: Thu, 5 Feb 2015 13:08:28 -0800 Subject: [PATCH] Change submodule to include slightly different styling, so newly added ToC depth will render nicely. --- .gitmodules | 4 +++ docs/source/config/inputs/index_noref.rst | 38 ++--------------------- docs/source/config/inputs/logstreamer.rst | 2 +- docs/source/index.rst | 2 +- 4 files changed, 9 insertions(+), 37 deletions(-) diff --git a/.gitmodules b/.gitmodules index e69de29bb..444c63892 100644 --- a/.gitmodules +++ b/.gitmodules @@ -0,0 +1,4 @@ +[submodule "docs/source/_themes/mozilla"] + path = docs/source/_themes/mozilla + url = https://github.com/rafrombrc/mozilla-sphinx-theme.git + branch = heka diff --git a/docs/source/config/inputs/index_noref.rst b/docs/source/config/inputs/index_noref.rst index 56ead62d4..8736a0171 100644 --- a/docs/source/config/inputs/index_noref.rst +++ b/docs/source/config/inputs/index_noref.rst @@ -3,41 +3,9 @@ Inputs ====== -Common Input Parameters -======================= - -.. versionadded:: 0.9 - -There are some configuration options that are universally available to all -Heka input plugins. These will be consumed by Heka itself when Heka -initializes the plugin and do not need to be handled by the plugin-specific -initialization code. - -- decoder (string, optional): - Decoder to be used by the input. This should refer to the name of a - registered decoder plugin configuration. If supplied, messages will be - decoded before being passed on to the router when the InputRunner's - `Deliver` method is called. -- synchronous_decode (bool, optional): - If `synchronous_decode` is false, then any specified decoder plugin will - be run by a DecoderRunner in its own goroutine and messages will be passed - in to the decoder over a channel, freeing the input to start processing - the next chunk of incoming or available data. If true, then any decoding - will happen synchronously and message delivery will not return control to - the input until after decoding has completed. Defaults to false. -- send_decode_failures (bool, optional): - If false, then if an attempt to decode a message fails then Heka will log - an error message and then drop the message. If true, then in addition to - logging an error message, decode failure will cause the original, - undecoded message to be tagged with a `decode_failure` field (set to true) - and delivered to the router for possible further processing. -- splitter (string, optional) - Splitter to be used by the input. This should refer to the name of a - registered splitter plugin configuration. It specifies how the input - should split the incoming data stream into individual records prior to - decoding and/or injection to the router. Typically defaults to - "NullSplitter", although certain inputs override this with a different - default value. +.. include:: /config/inputs/index.rst + :start-line: 9 + :end-line: 44 .. include:: /config/inputs/amqp.rst :start-line: 1 diff --git a/docs/source/config/inputs/logstreamer.rst b/docs/source/config/inputs/logstreamer.rst index 1f0d34fa7..fd37ce360 100644 --- a/docs/source/config/inputs/logstreamer.rst +++ b/docs/source/config/inputs/logstreamer.rst @@ -1,6 +1,6 @@ .. _config_logstreamer_input: -Log Streamer Input +Logstreamer Input ================== .. versionadded:: 0.5 diff --git a/docs/source/index.rst b/docs/source/index.rst index 00a654976..81dbc07a6 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -139,7 +139,7 @@ hekad Command Line Options Contents: .. toctree:: - :maxdepth: 2 + :maxdepth: 3 installing getting_started