added some initial docs

docs/source/basic-tools.rst

+.. list of basic cli tools
+
+CLI Tools
+=========================
+
+.. automodule:: resource_management.cli

docs/source/conf.py

@@ -58,7 +58,8 @@ author = 'GN5'
 extensions = [
   'sphinx_rtd_theme',
   'sphinx.ext.autodoc',
-  'sphinx.ext.coverage'
+  'sphinx.ext.coverage',
+  'sphinx.ext.todo'
 ]
 
 templates_path = ['_templates']
@@ -78,3 +79,6 @@ html_static_path = ['_static']
 autoclass_content = 'both'
 autodoc_typehints = 'none'
 
+# Display todos by setting to True
+todo_include_todos = True
+

docs/source/index.rst

@@ -3,13 +3,22 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to NAT Resource Management's documentation!
-===================================================
+NAT Resource Management
+==========================
+
+Documentation for the NAT Resource Management tools
+
+------------------
+
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Contents:
 
+   basic-tools
+
+
+
 
 
 Indices and tables

resource_management/cli.py

+"""
+
+script name [TODO]
+====================
+
+.. code-block:: bash
+
+    Usage: script name [OPTIONS]
+
+      notes: - first call init_db(dns=mysql_dsn(params from config)) - then create
+      a session (as in unit test) - ... and perform the db queries
+
+    Options:
+      --config FILENAME  config filename  [required]
+      --fqdn TEXT        config filename  [required]
+      --help             Show this message and exit.
+
+The configuration filename must be formatted according
+to this schema:
+
+    .. asjson::
+       resource_management.config.CONFIG_SCHEMA
+
+
+.. todo::
+
+    add a console script alias and change the name (cli.py) below
+
+
+"""
 import json
 
 import click