.. default-role:: literal
.. currentmodule:: eop

Getting started with EOP
========================

.. todo:: la prise en main 

Plugins
-----------

In the :file:`modules` directory, every sub-folder witch are present are dynamically imported.
A plugin is a module in the python way, that is it must have a `__init__.py`
inside. 

In addition, every module must have a :file:`menu.conf` present. It is a `json`
file 

.. todo:: document le format json du menu

.. todo:: renseigner tout ce qu'il faut pour faire un module


The :func:`get_module()` function dynamically retrieves the modules that are 
to be included in the application.


.. function:: get_module(path)

   
    automatically retrieves all modules names and paths recursively

    :param path: typically `eop/modules` at first call, but will change
                 at the other recursive calls


Menus
------------------

A :term:`menu` is loaded. 

.. todo:: description des menus

.. glossary:: 

    menu
        specific json file that describes the different links in the html
        application 
