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

updating documentation

Browse Source
This commit is contained in:
dtomlinson
2020-01-15 00:43:13 +00:00
parent 5d849b75dc
commit 1d9d75cb2b
2 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.rst
View File

@@ -29,7 +29,7 @@ You can install ``panaetius`` the following ways:
Python
-------
Install into a virtual environment.
.. Attention:: You should install in a python virtual environment
From pypi using pip
~~~~~~~~~~~~~~~~~~~~
@@ -48,6 +48,7 @@ Download the latest verion from the `releases`_ page.
Install with pip:
.. code-block:: bash
pip install -U panaetius-1.0.2-py3-none-any.whl

8
docs/source/introduction.rst
View File

@@ -71,7 +71,7 @@ Setting values in your code
Values in a ``config.toml`` or from an environment variable need to be set in your work in order for you to use them. You can do this easily by
- importing panaetius.
- using the :func:`panaetius.library.set_config` function.
- using the :func:`~panaetius.library.set_config` function.
E.g your script could contain:
@@ -82,11 +82,11 @@ E.g your script could contain:
.. 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::
The default value for a variable defined using :func:`panaetius.library.set_config` is ``None``. See the documentation of this function to see all the options available.
The default value for a variable defined using :func:`~panaetius.library.set_config` is ``None``. See the documentation of this function to see all the options available.
Accessing values
@@ -102,7 +102,7 @@ You can then access the result of this variable later in your code:
Logging
~~~~~~~~
In order to save to disk, you need to specify a path for the log file in the config file/environment variable. There is no need to register this with :func:`panaetius.library.set_config` as ``panaetius`` will do this automatically.
In order to save to disk, you need to specify a path for the log file in the config file/environment variable. There is no need to register this with :func:`~panaetius.library.set_config` as ``panaetius`` will do this automatically.
There are other options available for you to configure a logger. These are (including the default values which can be overwritten):