DOCS: fix some sphinx warnings

This commit fixes various errors and warnings from sphinx, mostly due to
wrong indents.

Author: Birger Schacht

docs/dev/guide.rst

@@ -295,7 +295,7 @@ Class name of the bot (ex: PhishTank Parser) must correspond to the type of the
 
 
 IntelMQ Data Format Rules
-========================
+=========================
 
 Any component of IntelMQ MUST respect the IntelMQ Data Format.
 

docs/user/intelmq-manager.rst

@@ -29,7 +29,7 @@ When using distribution packages, the webserver configuration (which is also sho
 The webinterface is then available at ``http://localhost/intelmq-manager``.
 
 Installation using pip
-^^^^^^^^^^^^^^^^^^^^^^
+======================
 
 For installation via pip, the situation is more complex.
 ``pip3 install intelmq-manager`` installs the HTML files in ``${PREFIX}/usr/share/intelmq-manager/html``.
@@ -80,7 +80,7 @@ Configuration
 In the file ``/usr/share/intelmq-manager/html/js/vars.js`` set ``ROOT`` to the URL of your ``intelmq-api`` installation- by default that's on the same host as ``intelmq-manager``.
 
 CSP Headers
-==========
+===========
 
 It is recommended to set these two headers for all requests:
 

intelmq/bin/intelmqctl.py

@@ -977,29 +977,32 @@ def upgrade_conf(self, previous=None, dry_run=None, function=None,
             state_file: location of the state file
             no_backup: Do not create backups of state and configuration files
 
-        state file:
-
-            version_history = [..., [2, 0, 0], [2, 0, 1]]
-            upgrades = {
-                "v112_feodo_tracker_domains": true,
-                "v112_feodo_tracker_ips": false,
-                "v200beta1_ripe_expert": false
-                }
-            results = [
-                {"function": "v112_feodo_tracker_domains",
-                 "success": true,
-                 "retval": null,
-                 "time": "..."},
-                {"function": "v112_feodo_tracker_domains",
-                 "success": false,
-                 "retval": "fix it manually",
-                 "message": "fix it manually",
-                 "time": "..."},
-                {"function": "v200beta1_ripe_expert",
-                 "success": false,
-                 "traceback": "...",
-                 "time": "..."}
-                ]
+        state_file:
+
+            .. code-block:: json
+
+               version_history = [..., [2, 0, 0], [2, 0, 1]]
+               upgrades = {
+                   "v112_feodo_tracker_domains": true,
+                   "v112_feodo_tracker_ips": false,
+                   "v200beta1_ripe_expert": false
+                   }
+               results = [
+                   {"function": "v112_feodo_tracker_domains",
+                    "success": true,
+                    "retval": null,
+                    "time": "..."},
+                   {"function": "v112_feodo_tracker_domains",
+                    "success": false,
+                    "retval": "fix it manually",
+                    "message": "fix it manually",
+                    "time": "..."},
+                   {"function": "v200beta1_ripe_expert",
+                    "success": false,
+                    "traceback": "...",
+                    "time": "..."}
+                   ]
+
         """
         if os.path.isfile(state_file):
             if not os.access(state_file, os.W_OK) and not dry_run:
@@ -1223,8 +1226,6 @@ def upgrade_conf(self, previous=None, dry_run=None, function=None,
     def debug(self, sections=None):
         """
         Give debugging output
-        get_paths:
-            print path information
         """
 
         output = {}

intelmq/bots/collectors/http/collector_http.py

@@ -7,24 +7,24 @@
 HTTP collector bot
 
 Parameters:
-http_url: string
-http_header: dictionary
-    default: {}
-http_verify_cert: boolean
-    default: True
-extract_files: value used to extract files from downloaded compressed file
-    default: None
-    all: True; some: string with file names separated by ,
-http_url_formatting: bool|json to turn on time formatting (and to specify delta to current time)
-http_username, http_password: string
-http_proxy, https_proxy: string
-http_timeout_sec: tuple of two floats or float
-http_timeout_max_tries: an integer depicting how often a connection attempt is retried
-verify_pgp_signatures: whether to download and check file signatures
-    default: False
-signature_url: string
-signature_url_formatting: the same as http_url_formatting
-gpg_keyring: none (defaults to user's GPG keyring) or string (path to keyring file)
+    http_url (string)
+    http_header (dictionary): default: {}
+    http_verify_cert (boolean): default: True
+    extract_files: value used to extract files from downloaded compressed file
+        default: None
+        all: True; some: string with file names separated by ,
+    http_url_formatting (bool|json): to turn on time formatting (and to specify delta to current time)
+    http_username (string)
+    http_password (string)
+    http_proxy (string)
+    https_proxy (string)
+    http_timeout_sec: tuple of two floats or float
+    http_timeout_max_tries (int): an integer depicting how often a connection attempt is retried
+    verify_pgp_signatures (bool): whether to download and check file signatures
+        default: False
+    signature_url (string)
+    signature_url_formatting: the same as http_url_formatting
+    gpg_keyring: none (defaults to user's GPG keyring) or string (path to keyring file)
 """
 from datetime import datetime, timedelta
 

intelmq/bots/collectors/http/collector_http_stream.py

@@ -7,15 +7,15 @@
 HTTP collector bot
 
 Parameters:
-http_url: string
-http_header: dictionary
-    default: {}
-http_verify_cert: boolean
-    default: True
-http_username, http_password: string
-http_proxy, https_proxy: string
-strip_lines: boolean
-http_timeout_sec: tuple of two floats or float
+    http_url: string
+    http_header: dictionary
+        default: {}
+    http_verify_cert: boolean
+        default: True
+    http_username, http_password: string
+    http_proxy, https_proxy: string
+    strip_lines: boolean
+    http_timeout_sec: tuple of two floats or float
 """
 
 from http.client import IncompleteRead

intelmq/bots/collectors/misp/collector.py

@@ -6,17 +6,16 @@
 """A collector for grabbing appropriately tagged events from MISP.
 
 Parameters:
-  - misp_url: URL of the MISP server
-  - misp_key: API key for accessing MISP
-  - misp_tag_to_process: MISP tag identifying events to be processed
-  - misp_tag_processed: MISP tag identifying events that have been processed
+    misp_url: URL of the MISP server
+    misp_key: API key for accessing MISP
+    misp_tag_to_process: MISP tag identifying events to be processed
+    misp_tag_processed: MISP tag identifying events that have been processed
 
 
-PyMISP versions released after January 2020 will no longer support the
-"old" PyMISP class.
+PyMISP versions released after January 2020 will no longer support the "old" PyMISP class.
 For compatibility:
- * older versions of pymisp still work with this bot
- * the deprecated parameter `misp_verify` will create a DeprecationWarning
+* older versions of pymisp still work with this bot
+* the deprecated parameter `misp_verify` will create a DeprecationWarning
 """
 import json
 import warnings

intelmq/bots/collectors/shadowserver/collector_reports_api.py

@@ -24,16 +24,12 @@ class ShadowServerAPICollectorBot(CollectorBot, HttpMixin, CacheMixin):
     """
     Connects to the Shadowserver API, requests a list of all the reports for a specific country and processes the ones that are new
 
-    Parameters
-    ----------
-    api_key: str
-        Your Shadowserver API key
-    secret: str
-        Your Shadowserver API secret
-    country: str
-        The country you want to download reports for (i.e. 'austria')
-    types: list
-        A list of strings or a string of comma-separated values with the names of reporttypes you want to process. If you leave this empty, all the available reports will be downloaded and processed (i.e. 'scan', 'drones', 'intel', 'sandbox_connection', 'sinkhole_combined').
+    Parameters:
+        api_key (str): Your Shadowserver API key
+        secret (str): Your Shadowserver API secret
+        country (str): The country you want to download reports for (i.e. 'austria')
+        types (list):
+            A list of strings or a string of comma-separated values with the names of reporttypes you want to process. If you leave this empty, all the available reports will be downloaded and processed (i.e. 'scan', 'drones', 'intel', 'sandbox_connection', 'sinkhole_combined').
     """
 
     country = None

intelmq/bots/experts/http/expert_status.py

@@ -14,15 +14,14 @@ class HttpStatusExpertBot(ExpertBot):
     """
     Fetch the HTTP Status for a given URL
 
-    Parameters
-    ----------
-    field: str
-        The name of the field containing the URL to be checked (defaults to 'source.url').
-    success_status_codes: List
-        A list of success status codes. If this parameter is omitted or the list is empty,
-        successful status codes are the ones between 200 and 400.
-    overwrite:
-        Specifies if an existing 'status' value should be overwritten.
+    Parameters:
+        field (str):
+            The name of the field containing the URL to be checked (defaults to 'source.url').
+        success_status_codes (List):
+            A list of success status codes. If this parameter is omitted or the list is empty,
+            successful status codes are the ones between 200 and 400.
+        overwrite (bool):
+            Specifies if an existing 'status' value should be overwritten.
     """
     field: str = "source.url"  # The field containing the URL
     success_status_codes: List[int] = []  # A list of status codes for success

intelmq/bots/experts/jinja/expert.py

@@ -19,10 +19,12 @@ class JinjaExpertBot(Bot):
     """
     Modify the message using the Jinja templating engine
     Example:
-    fields:
-      output: The provider is {{ msg['feed.provider'] }}!
-      feed.url: "{{ msg['feed.url'] | upper }}"
-      extra.somejinjaoutput: file:///etc/intelmq/somejinjatemplate.j2
+        .. code-block:: yaml
+
+        fields:
+          output: The provider is {{ msg['feed.provider'] }}!
+          feed.url: "{{ msg['feed.url'] | upper }}"
+          extra.somejinjaoutput: file:///etc/intelmq/somejinjatemplate.j2
     """
 
     fields: Dict[str, Union[str, Template]] = {}

intelmq/bots/experts/splunk_saved_search/expert.py

@@ -44,8 +44,7 @@
                               search returns more than one result. All
                               specified actions are performed. Any
                               reasonable combination of:
-                              limit: limit the search so that duplicates
-                                     are impossible
+                              limit: limit the search so that duplicates are impossible
                               warn: log a warning message
                               use_first: use the first search result
                               ignore: do not modify the event