dtomlinson/panaetius
1
0
Fork 0
mirror of https://github.com/dtomlinson91/panaetius.git synced 2025-12-22 04:55:44 +00:00
Code Issues Projects Releases Wiki Activity

updating documentation

Browse Source
This commit is contained in:
dtomlinson
2020-01-13 22:23:04 +00:00
parent 0b1abf6bf5
commit 890f70fde7
1 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/source/modules/panaetius.rst
View File

@@ -1,8 +1,8 @@
.. include:: ../global.rst
panaetius :modname:`panaetius`
-------------------------------------
*********
panaetius
*********
API
===
@@ -17,7 +17,7 @@ The following is availble by importing the module:
panaetius.CONFIG
----------------
``panaetius.CONFIG`` provides an instance of :class:`panaetius,config.Config`
``panaetius.CONFIG`` provides an instance of :class:`panaetius.config.Config`
panaetius.set_config()
@@ -39,10 +39,14 @@ Conveniently provides access to all attributes that have been declared with :fun
.. code-block:: python
panaetius.CONFIG.aws_secret_key
my_secret_key = panaetius.CONFIG.aws_secret_key
panaetius.logger
-----------------
``panaetius.logger`` provides a logger instance already formatted with a nice json output.
.. code-block:: python
panaetius.logger.info('some logging message')