From e841a49ca71c6e977b2c8755b69b1992c86a9109 Mon Sep 17 00:00:00 2001 From: Sean Whalen <44679+seanthegeek@users.noreply.github.com> Date: Sun, 20 Jun 2021 14:24:49 -0400 Subject: [PATCH] Fix documentation formatting --- README.rst | 9 ++++++--- docs/index.rst | 9 ++++++--- 2 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 517c50b..6e3f18c 100644 --- a/README.rst +++ b/README.rst @@ -161,12 +161,14 @@ The full set of configuration options are: - ``log_file`` - str: Write log messages to a file at this path - ``n_procs`` - int: Number of process to run in parallel when parsing in CLI mode (Default: 1) - ``chunk_size`` - int: Number of files to give to each process when running in parallel. - .. note:: + + .. note:: Setting this to a number larger than one can improve performance when processing thousands of files - ``imap`` - ``host`` - str: The IMAP server hostname or IP address - ``port`` - int: The IMAP server port (Default: 993). - .. note:: + + .. note:: If your host recommends another port, still try 993 - ``ssl`` - bool: Use an encrypted SSL/TLS connection (Default: True) - ``skip_certificate_verification`` - bool: Skip certificate verification (not recommended) @@ -180,7 +182,8 @@ The full set of configuration options are: - ``batch_size`` - int: Number of messages to read and process before saving. Defaults to all messages if not set. - ``elasticsearch`` - ``hosts`` - str: A comma separated list of hostnames and ports or URLs (e.g. ``127.0.0.1:9200`` or ``https://user:secret@localhost``) - .. note:: + + .. note:: Special characters in the username or password must be `URL encoded`_. - ``ssl`` - bool: Use an encrypted SSL/TLS connection (Default: True) - ``cert_path`` - str: Path to a trusted certificates diff --git a/docs/index.rst b/docs/index.rst index 6e36e89..e84c3b5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -165,12 +165,14 @@ The full set of configuration options are: - ``log_file`` - str: Write log messages to a file at this path - ``n_procs`` - int: Number of process to run in parallel when parsing in CLI mode (Default: 1) - ``chunk_size`` - int: Number of files to give to each process when running in parallel. - .. note:: + + .. note:: Setting this to a number larger than one can improve performance when processing thousands of files - ``imap`` - ``host`` - str: The IMAP server hostname or IP address - ``port`` - int: The IMAP server port (Default: 993). - .. note:: + + .. note:: If your host recommends another port, still try 993 - ``ssl`` - bool: Use an encrypted SSL/TLS connection (Default: True) - ``skip_certificate_verification`` - bool: Skip certificate verification (not recommended) @@ -184,7 +186,8 @@ The full set of configuration options are: - ``batch_size`` - int: Number of messages to read and process before saving. Defaults to all messages if not set. - ``elasticsearch`` - ``hosts`` - str: A comma separated list of hostnames and ports or URLs (e.g. ``127.0.0.1:9200`` or ``https://user:secret@localhost``) - .. note:: + + .. note:: Special characters in the username or password must be `URL encoded`_. - ``ssl`` - bool: Use an encrypted SSL/TLS connection (Default: True) - ``cert_path`` - str: Path to a trusted certificates