From 890f70fde71942ff6b534048547260b32ceeda61 Mon Sep 17 00:00:00 2001 From: dtomlinson Date: Mon, 13 Jan 2020 22:23:04 +0000 Subject: [PATCH] updating documentation --- docs/source/modules/panaetius.rst | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/source/modules/panaetius.rst b/docs/source/modules/panaetius.rst index 2b17ffd..bd1a1f9 100644 --- a/docs/source/modules/panaetius.rst +++ b/docs/source/modules/panaetius.rst @@ -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')