updating documentation

docs/source/modules/panaetius.config.rst

@@ -1,6 +1,6 @@
 .. include:: ../global.rst
 
-Config :modname:`panaetius.config`
+panaetius.config :modname:`panaetius.config`
 -------------------------------------
 
 .. automodule:: panaetius.config

docs/source/modules/panaetius.config_inst.rst

@@ -1,6 +1,6 @@
 .. include:: ../global.rst
 
-Config :modname:`panaetius.config_inst`
+panaetius.config_inst :modname:`panaetius.config_inst`
 ---------------------------------------
 
 .. automodule:: panaetius.config_inst

docs/source/modules/panaetius.db.rst

@@ -1,6 +1,6 @@
 .. include:: ../global.rst
 
-Config :modname:`panaetius.db`
+panaetius.db :modname:`panaetius.db`
 -------------------------------------
 
 .. automodule:: panaetius.db

docs/source/modules/panaetius.header.rst

@@ -1,6 +1,6 @@
 .. include:: ../global.rst
 
-Config :modname:`panaetius.header`
+panaetius.header :modname:`panaetius.header`
 -------------------------------------
 
 .. automodule:: panaetius.header

docs/source/modules/panaetius.library.rst

@@ -1,6 +1,6 @@
 .. include:: ../global.rst
 
-Config :modname:`panaetius.library`
+panaetius.library :modname:`panaetius.library`
 -------------------------------------
 
 .. automodule:: panaetius.library

docs/source/modules/panaetius.logging.rst

@@ -1,7 +1,7 @@
 .. include:: ../global.rst
 
-Config :modname:`panaetius.logging`
+panaetius.logging :modname:`panaetius.logging`
--------------------------------------
+----------------------------------------------
 
 .. automodule:: panaetius.logging
    :members:

docs/source/modules/panaetius.rst

@@ -1,6 +1,6 @@
 .. include:: ../global.rst
 
-Config :modname:`panaetius`
+panaetius :modname:`panaetius`
 -------------------------------------
 
 .. automodule:: panaetius

pyproject.toml

@@ -7,7 +7,7 @@ authors = ["dtomlinson <dtomlinson@panaetius.co.uk>"]
 readme = "/Users/dtomlinson/git-repos/projects/panaetius/README.md"
 homepage = "https://github.com/dtomlinson91/panaetius"
 repository = "https://github.com/dtomlinson91/panaetius"
-documentation = "https://github.com/dtomlinson91/panaetius"
+documentation = "https://panaetius.readthedocs.io/en/latest/introduction.html"
 classifiers = [
     "Environment :: Plugins",
     "Intended Audience :: Developers",

src/panaetius/library.py

@@ -56,23 +56,23 @@ def set_config(
         to define a list, but want to make sure that a string representation
         of a list will be loaded properly if it set as an environment variable.
 
-    Example:
+        Example:
 
-    `config.toml` has the following attribute set:
+        `config.toml` has the following attribute set:
-    ```
+        ```
-        [package.users]
+            [package.users]
-        auth = ['user1', 'user2']
+            auth = ['user1', 'user2']
-    ```
+        ```
 
-    If set as an environment variable you can pass this list as a string
+        If set as an environment variable you can pass this list as a string
-    and set check=list:
+        and set check=list:
 
-    Environment variable:
+        Environment variable:
-    PACKAGE_USERS_AUTH = "['user1', 'user2']"
+        PACKAGE_USERS_AUTH = "['user1', 'user2']"
 
-    Usage in code:
+        Usage in code:
-    ```python
+        ```python
-    set_config(CONFIG, 'users.auth', check=list)
+        set_config(CONFIG, 'users.auth', check=list)
         ```
     """
     config_var = key.lower().replace('.', '_')