updating documentation

This commit is contained in:
2020-01-15 01:13:49 +00:00
parent 1d9d75cb2b
commit 4b46980312
3 changed files with 14 additions and 4 deletions

View File

@@ -3,7 +3,7 @@ Configuration
panaetius is fairly easy to configure. There are just a couple of options to be aware of.
header.py
__header__.py
----------
You should set a ``__header__.py`` next to your script or module.
@@ -16,6 +16,16 @@ E.g a ``__header__.py`` for the module ``plex_posters`` would look like:
__header__ = 'plex_posters'
Your config file can then be created at ``~/.config/__header__/config.toml``. The headers of the toml file would look like:
.. code-block:: toml
[__header__]
foo = bar
[__header__.subsection]
foo = bar
If you are writing a script, simply place this ``__header__.py`` along side your script. Panaetius will pick this up when the script is ran.
If you are writing a module, you can either place the ``__header__.py`` alongside the script that uses your module. If this is not possible, panaetius will set the default ``__header__`` variable to the name of the virtualenv that the script is activated from.

View File

@@ -1,5 +1,5 @@
panaetius
==========
Introduction
=============
.. image:: https://img.shields.io/readthedocs/panaetius?style=for-the-badge :target: https://panaetius.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status