Skip to content

Commit

Permalink
Document how module sections are created
Browse files Browse the repository at this point in the history
  • Loading branch information
JakobGM committed Feb 8, 2018
1 parent 2989581 commit 3f85716
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 0 deletions.
49 changes: 49 additions & 0 deletions docs/modules.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,52 @@
=======
Modules
=======

What are modules?
=================

Tasks to be performed by Astrality are grouped into so-called ``modules``.
These modules are used to define:

:ref:`templates`
Configuration file templates that are available for compilation.

:doc:`timers`
Timers can trigger events when certain predefined :ref:`periods` occur.

:ref:`actions`
Tasks to be performed when :ref:`events` occur.

How to define a module
======================

Modules are defined in ``astrality.yaml``.
They should be formated as *dictionaries* placed at the root indentation level, and **must** be named ``module/*``.
Choose ``*`` to be whatever you want to name your module.
The simplest module, with no associated behaviour, is:

.. code-block:: yaml
module/test_module:
enabled: true
Astrality skips parsing any modules which contain the option :code:`enabled: false`.
The default value of ``enabled`` is ``true``.

.. _templates:

Templates
=========
TODO

.. _events:

Events
======
TODO

.. _actions:

Actions
=======
TODO
7 changes: 7 additions & 0 deletions docs/timers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@
Timers
======

.. _periods:

Periods
=======

TODO: Explain periods

Solar Timer
===========

Expand Down

0 comments on commit 3f85716

Please sign in to comment.