Added all existing documentation pages to master documentation.

(Redmine issue: #3361)

.gitignore

@@ -34,3 +34,6 @@ parsetab.py
 # Ignore submodule documentation.
 /doc/sphinx/_doclib/api_pyzenkit*.rst
 /doc/sphinx/_doclib/api_pynspect*.rst
+/doc/sphinx/_doclib/_inc_bin.cfg-app.rst
+/doc/sphinx/_doclib/_inc_bin.cfg-daemon.rst
+/doc/sphinx/_doclib/_inc_bin.cfg-script.rst

doc/sphinx/_doclib/_inc.bin.app-opt.rst

-``--help``
-    Display help and usage description and exit (*flag*)
-
-``--name alternative-name``
-    Alternative name for application instead of default ``$0``, using which names
-    for log, runlog, pid, status and other files will be generated.
-
-    *Type:* ``string``, *default:* ``$0``
-
-``--quiet``
-    Run in quiet mode (*flag*).
-
-    Do not write anything to ``stdout`` or ``stderr``.
-
-    *Type:* ``boolean``, *default:* ``False``
-
-``--verbose``
-    Increase application output verbosity (*flag*, *repeatable*).
-
-    *Type:* ``boolean``, *default:* ``False``
-
-``--log-file file-name``
-    Name of the log file.
-
-    *Type:* ``string``, *default:* autodetected
-
-``--log-level level``
-    Logging level [``debug``, ``info``, ``warning``, ``error``, ``critical``].
-
-    *Type:* ``string``, *default:* ``info``
-
-``--runlog-dir dir-name``
-    Name of the runlog directory.
-
-    *Type:* ``string``, *default:* autodetected
-
-``--runlog-dump``
-    Dump runlog to stdout when done processing (*flag*).
-
-    *Type:* ``boolean``, *default:* ``False``
-
-``--runlog_log``
-    Write runlog to logging service when done processing (*flag*)
-
-    *Type:* ``boolean``, *default:* ``False``
-
-``--pstate_file file-name``
-    Name of the persistent state file.
-
-    *Type:* ``string``, *default:* autodetected
-
-``--pstate_dump``
-    Dump persistent state to stdout when done processing (*flag*).
-
-    *Type:* ``boolean``, *default:* ``False``
-
-``--pstate_log``
-    Write persistent state to logging service when done processing (*flag*).
-
-    *Type:* ``boolean``, *default:* ``False``
-
-``--action action``
-    Execute given quick action and exit. List of available actions can be displayed with ``--help`` option.
-
-    *Type:* ``string``, *default:* ``None``
-
-``--user name-or-id``
-    Name/gid of the system user for process permissions.
-
-    *Type:* ``string``, *default:* ``None``
-
-``--group name-or-id``
-    Name/gid of the system group for process permissions.
-
-    *Type:* ``string``, *default:* ``None``

doc/sphinx/_doclib/_inc.bin.daemon-opt.rst

-``--no-daemon``
-    Do not daemonize and stay in foreground (*flag*).
-
-    *Type:* ``boolean``, *default:* ``False``
-
-``--chroot-dir dir-name``
-    Name of the chroot directory.
-
-    *Type:* ``string``, *default:* ``None``
-
-``--work_dir dir-name``
-    Name of the process work directory.
-
-    *Type:* ``string``, *default:* ``/``
-
-``--pid_file file-name``
-    Name of the pid file.
-
-    *Type:* ``string``, *default:* autodetected
-
-``--state_file file-name``
-    Name of the state file.
-
-    *Type:* ``string``, *default:* autodetected
-
-``--umask mask``
-    Default file umask.
-
-    *Type:* ``string``, *default:* ``0o002``
-
-``--stats_interval interval``
-    Processing statistics display interval in seconds.
-
-    *Type:* ``integer``, *default:* ``300``
-
-``--paralel``
-    Run in paralel mode (*flag*).
-
-    *Type:* ``boolean``, *default:* ``False``

doc/sphinx/_doclib/_inc.bin.script-opt.rst

-``--regular``
-    Operational mode: regular script execution (*flag*). Conflicts with ``--shell`` option.
-
-    *Type:* ``boolean``, *default:* ``False``
-
-``--shell``
-    Operational mode: manual script execution from shell (*flag*). Conflicts with ``--regular`` option.
-
-    *Type:* ``boolean``, *default:* ``False``
-
-``--command name``
-    Name of the script command to be executed.
-
-    *Type:* ``string``, *default:* autodetected
-
-``--interval interval``
-    Execution interval. This value should correspond with related cron script.
-
-    *Type:* ``string``, *default:* ``daily``
-
-``--adjust_thresholds``
-    Round-up time interval threshols to interval size (*flag*).
-
-    *Type:* ``boolean``, *default:* ``False``
-
-``--time_high time``
-    Upper time interval threshold.
-
-    *Type:* ``float``, *default:* time.time

doc/sphinx/_doclib/_inc_bin.help.daemon.rst

@@ -28,15 +28,23 @@ Common application options
 Following configuration options are available for all applications based on
 :py:mod:`pyzenkit.baseapp`:
 
-.. include:: _inc.bin.app-opt.rst
+.. include:: _inc_bin.cfg-app.rst
 
 Common daemon options
 ````````````````````````````````````````````````````````````````````````````````
 
-Following configuration options are available on top of common applicationsoptions
-for all applications based on :py:mod:`pyzenkit.zenscript`:
+Following configuration options are available on top of common application options
+for all applications based on :py:mod:`pyzenkit.zendaemon`:
 
-.. include:: _inc.bin.daemon-opt.rst
+.. include:: _inc_bin.cfg-daemon.rst
+
+Common piper daemon options
+````````````````````````````````````````````````````````````````````````````````
+
+Following configuration options are available on top of common daemon options
+for all applications based on :py:mod:`mentat.daemon.piper`:
+
+.. include:: _inc_bin.cfg-piper.rst
 
 
 Configuration files and directories

doc/sphinx/_doclib/_inc_bin.help.script.rst

@@ -28,7 +28,7 @@ Common application options
 Following configuration options are available for all applications based on
 :py:mod:`pyzenkit.baseapp`:
 
-.. include:: _inc.bin.app-opt.rst
+.. include:: _inc_bin.cfg-app.rst
 
 Common script options
 ````````````````````````````````````````````````````````````````````````````````
@@ -36,7 +36,7 @@ Common script options
 Following configuration options are available on top of common applicationsoptions
 for all applications based on :py:mod:`pyzenkit.zenscript`:
 
-.. include:: _inc.bin.script-opt.rst
+.. include:: _inc_bin.cfg-script.rst
 
 
 Configuration files and directories

doc/sphinx/_doclib/api.rst

@@ -28,16 +28,36 @@ Python submodules
     api_mentat.datatype.internal
     api_mentat.datatype.mongodb
 
+    api_mentat.const
+    api_mentat.dirq
+    api_mentat.geoip
+    api_mentat.storage
+    api_mentat.whois
+
     api_mentat.stats.idea
     api_mentat.stats.rrd
 
+    api_mentat.plugin.app.storage
+
     api_mentat.plugin.enricher.geoip
+    api_mentat.plugin.enricher.logger
     api_mentat.plugin.enricher.whois
 
-    api_mentat.daemon.component.inspector
+    api_mentat.daemon.component.commiter
     api_mentat.daemon.component.enricher
+    api_mentat.daemon.component.filer
+    api_mentat.daemon.component.filter
+    api_mentat.daemon.component.inspector
+    api_mentat.daemon.component.mailer
+    api_mentat.daemon.component.parser
+    api_mentat.daemon.component.printer
+    api_mentat.daemon.component.sampler
     api_mentat.daemon.component.storage
 
+    api_mentat.script.fetcher
+
+    api_mentat.daemon.piper
+
     api_mentat.module.backup
     api_mentat.module.cleanup
     api_mentat.module.controller

doc/sphinx/_doclib/api_mentat.daemon.piper.rst

+.. _section-api-mentat-daemon-piper:
+
 mentat.daemon.piper
 ================================================================================