diff --git a/docs/source/modules/panaetius.config.rst b/docs/source/modules/panaetius.config.rst index 7fcfe0e..eca3252 100644 --- a/docs/source/modules/panaetius.config.rst +++ b/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 diff --git a/docs/source/modules/panaetius.config_inst.rst b/docs/source/modules/panaetius.config_inst.rst index 9ad52be..57a6bbc 100644 --- a/docs/source/modules/panaetius.config_inst.rst +++ b/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 diff --git a/docs/source/modules/panaetius.db.rst b/docs/source/modules/panaetius.db.rst index ab00b8e..6ef6d90 100644 --- a/docs/source/modules/panaetius.db.rst +++ b/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 diff --git a/docs/source/modules/panaetius.header.rst b/docs/source/modules/panaetius.header.rst index 69ef1a4..2ce60e5 100644 --- a/docs/source/modules/panaetius.header.rst +++ b/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 diff --git a/docs/source/modules/panaetius.library.rst b/docs/source/modules/panaetius.library.rst index bde30e9..552dc86 100644 --- a/docs/source/modules/panaetius.library.rst +++ b/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 diff --git a/docs/source/modules/panaetius.logging.rst b/docs/source/modules/panaetius.logging.rst index b1947d8..e284181 100644 --- a/docs/source/modules/panaetius.logging.rst +++ b/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: diff --git a/docs/source/modules/panaetius.rst b/docs/source/modules/panaetius.rst index 790e3c9..bd32b75 100644 --- a/docs/source/modules/panaetius.rst +++ b/docs/source/modules/panaetius.rst @@ -1,6 +1,6 @@ .. include:: ../global.rst -Config :modname:`panaetius` +panaetius :modname:`panaetius` ------------------------------------- .. automodule:: panaetius diff --git a/pyproject.toml b/pyproject.toml index 4194704..d4954d7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,7 +7,7 @@ authors = ["dtomlinson "] 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", diff --git a/src/panaetius/library.py b/src/panaetius/library.py index 54538f1..039363b 100644 --- a/src/panaetius/library.py +++ b/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: - ``` - [package.users] - auth = ['user1', 'user2'] - ``` + `config.toml` has the following attribute set: + ``` + [package.users] + auth = ['user1', 'user2'] + ``` - If set as an environment variable you can pass this list as a string - and set check=list: + If set as an environment variable you can pass this list as a string + and set check=list: - Environment variable: - PACKAGE_USERS_AUTH = "['user1', 'user2']" + Environment variable: + PACKAGE_USERS_AUTH = "['user1', 'user2']" - Usage in code: - ```python - set_config(CONFIG, 'users.auth', check=list) + Usage in code: + ```python + set_config(CONFIG, 'users.auth', check=list) ``` """ config_var = key.lower().replace('.', '_')