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-14 00:56:59 +00:00
parent dae11adcc9
commit 428000a899
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/source/introduction.rst
View File

@@ -64,6 +64,7 @@ You can overwrite the ``config.toml`` location by setting the environment variab
DEFAULT_CONFIG_PATH = "~/path/to/config" DEFAULT_CONFIG_PATH = "~/path/to/config"
Setting values in your code Setting values in your code
############################ ############################
@@ -79,9 +80,9 @@ E.g your script could contain:
import panaetius import panaetius
panaetius.set_config(panaetius.CONFIG, 'logging.path') panaetius.set_config(panaetius.CONFIG, 'logging.path')
.. Note:: .. Note::
The ``key`` attribute in :func:`panaetius.library.set_config` is specified as a string, with the hirearchy in the config file split with a ``.``. The ``key`` attribute in :func:`panaetius.library.set_config` is specified as a string, with the hirearchy in the config file split with a ``.``.
.. Important:: .. Important::