From 0b1abf6bf58d8252694143541f54f1c16f8b72e1 Mon Sep 17 00:00:00 2001
From: dtomlinson <dtomlinson@panaetius.co.uk>
Date: Mon, 13 Jan 2020 22:18:59 +0000
Subject: [PATCH] updating documentation

---
 docs/source/modules/panaetius.rst | 45 ++++++++++++++++++++++++-------
 1 file changed, 36 insertions(+), 9 deletions(-)

diff --git a/docs/source/modules/panaetius.rst b/docs/source/modules/panaetius.rst
index c19d7fb..2b17ffd 100644
--- a/docs/source/modules/panaetius.rst
+++ b/docs/source/modules/panaetius.rst
@@ -3,19 +3,46 @@
 panaetius :modname:`panaetius`
 -------------------------------------
 
-.. automodule:: panaetius
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 
 API
----
+===
 
 The following is availble by importing the module:
 
 .. code-block:: python
- 
-     import panaetius
 
-:func:`panaetius.library.set_config`
+    import panaetius
+
+
+panaetius.CONFIG
+----------------
+
+``panaetius.CONFIG`` provides an instance of :class:`panaetius,config.Config`
+
+
+panaetius.set_config()
+-----------------------
+
+Conveniently provides :func:`panaetius.library.set_config` 
+
+Use in your module/script with:
+
+.. code-block:: python
+
+    panaetius.set_config(panaetius.CONFIG, 'aws.secret_key', str, mask=True)    
+
+
+panaetius.CONFIG.aws_secret_key
+-------------------------------
+
+Conveniently provides access to all attributes that have been declared with :func:`panaetius.library.set_config`:
+
+.. code-block:: python
+
+    panaetius.CONFIG.aws_secret_key
+
+
+panaetius.logger
+-----------------
+
+``panaetius.logger`` provides a logger instance already formatted with a nice json output.