Fix: Fix documentation warnings (Redmine issue: #7645)

doc/sphinx/_doclib/database.rst

@@ -61,9 +61,7 @@ Following options were changed in the main configuration file ``/etc/postgresql/
     # Original default value 'localtime'
     timezone = 'UTC'
 
-* Timezone must be set to UTC to enable proper time based searching. All timestamps
-are converted to UTC prior to storing to database and stored without the timezone
-information according to PostgreSQL best practices.
+* Timezone must be set to UTC to enable proper time based searching. All timestamps are converted to UTC prior to storing to database and stored without the timezone information according to PostgreSQL best practices.
 
 .. code-block:: shell
 

doc/sphinx/_doclib/development.rst

@@ -526,12 +526,12 @@ Important resources:
 * `Alembic <https://alembic.sqlalchemy.org/en/latest/index.html>`__
 * `Flask-Migrate <https://flask-migrate.readthedocs.io/en/latest/>`__
 
-Creating new database migration::
+Creating new database migration:
 
-1. Perform requested changes in ``lib/mentat/datatype/sqldb.py`` and ``lib/mentat/datatype/test_sqldb.py``
-2. Execute ``hawat-cli db migrate`` to autogenerate migration script
-3. Review and update autogenerated migration script in ``lib/hawat/migrations/versions`` directory
-4. Execute ``hawat-cli db upgrade`` aply locally your migration
+#. Perform requested changes in ``lib/mentat/datatype/sqldb.py`` and ``lib/mentat/datatype/test_sqldb.py``
+#. Execute ``hawat-cli db migrate`` to autogenerate migration script
+#. Review and update autogenerated migration script in ``lib/hawat/migrations/versions`` directory
+#. Execute ``hawat-cli db upgrade`` aply locally your migration
 
 
 Versioning

doc/sphinx/_doclib/hawat.rst

@@ -73,7 +73,7 @@ configuration options:
 	ENABLED_BLUEPRINTS = [
 	     'hawat.blueprints.auth_api',
 	     'hawat.blueprints.auth_env',
-	     'hawat.blueprints.design',
+	     'hawat.blueprints.design_bs3',
 	     'hawat.blueprints.home',
 	     'hawat.blueprints.reports',
 	     'hawat.blueprints.events',

doc/sphinx/_doclib/hawat_plugin_design.rst

 .. _section-hawat-plugin-design:
 
-design
+design_bs3
 ================================================================================
 
-.. automodule:: hawat.blueprints.design
+.. automodule:: hawat.blueprints.design_bs3
     :noindex:

doc/sphinx/_doclib/hawat_plugin_help.rst

-.. _section-hawat-plugin-help:
-
-help
-================================================================================
-
-.. automodule:: hawat.blueprints.help
-    :noindex:

doc/sphinx/_doclib/hawat_plugin_pdnsr.rst

-.. _section-hawat-plugin-networks:
+.. _section-hawat-plugin-pdnsr:
 
-networks
+pdnsr
 ================================================================================
 
-.. automodule:: hawat.blueprints.networks
+.. automodule:: hawat.blueprints.pdnsr
     :noindex:

doc/sphinx/_doclib/hawat_plugin_reports.rst

@@ -161,9 +161,3 @@ following keys:
 .. code-block:: shell
 
     $ curl -X POST -d "api_key=your%AP1_k3y" "https://.../api/reports/dashboard?submit=Search"
-
-.. note::
-
-    Please be aware, that this endpoint provides raw statistical dataset. The :ref:`section-hawat-plugin-reports-features-dashboard`
-    endpoint performs some additional client-side processing with JavaScript to transform
-    datasets provided by this endpoint into format appropriate for chart and table rendering.

doc/sphinx/_doclib/hawat_plugin_timeline.rst

@@ -317,7 +317,7 @@ following keys:
     * *Description:* This subkey is present in case search was successfull. It contains
       list of all aggregations that were actually performed.
     * *Datatype:* ``list``
-    * *Default: ``["categories", "ips", "source_ports", "target_ports", "source_types", "target_types", "protocols", "detectors", "detector_types", "abuses",  "classes", "severities"]``
+    * *Default*: ``["categories", "ips", "source_ports", "target_ports", "source_types", "target_types", "protocols", "detectors", "detector_types", "abuses",  "classes", "severities"]``
 
 ``form_data``
     * *Description:* This subkey is present in case search operation was triggered.

lib/hawat/base.py

@@ -340,7 +340,7 @@ class HawatApp(flask.Flask):
         Send emails through all registered infomailer handles.
 
         :param str name: Name of the informailer.
-        :param **kwargs: Additional mailer arguments.
+        :param kwargs: Additional mailer arguments.
         """
         for mailer in self.infomailers[name]:
             mailer(**kwargs)

lib/hawat/blueprints/timeline/__init__.py

@@ -419,7 +419,7 @@ class APILegacySearchView(AJAXMixin, AbstractSearchView):  # pylint: disable=loc
     View responsible for querying `IDEA <https://idea.cesnet.cz/en/index>`__
     event database and presenting the results in the form of JSON document.
 
-    *Deprecated legacy implementation, kept only for the purposes of comparison.
+    *Deprecated legacy implementation, kept only for the purposes of comparison.*
     """
     methods = ['GET', 'POST']
 

lib/mentat/idea/internal.py

@@ -210,7 +210,7 @@ class Idea(idea.lite.Idea):  # pylint: disable=locally-disabled,too-many-ancesto
         """
         Convenience method for returning the correct custom key.
 
-        :return: The value of _Mentat if present, otherwise the value of _CESNET if present.
+        :return: The value of _Mentat if present, otherwise the value of _CESNET if present. \
         If neither of those keys exist then empty dictionary is returned.
         :rtype: mentat_dict
         """

lib/mentat/services/whois.py

@@ -272,7 +272,7 @@ class SqldbWhoisModule(WhoisModule):
 class WhoisService:
     """
     Implementation of more complex whois service capable of encapsulating multiple
-    :py:class:`mentat.services.whois.WhoisModule`s.
+    instances of :py:class:`mentat.services.whois.WhoisModule`.
     """
 
     def __init__(self, modules = None):