.. Energetic Stress Production documentation master file, created by
   sphinx-quickstart on Sun Jun 23 13:39:35 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Energetic Stress Production's documentation!
=======================================================


Welcome to the documentation of the Energetic Stress Production project.

The objective of this project is to predict the French Electricity Mix for the next few days.

.. grid:: 1 2 2 2

   .. grid-item-card:: Getting started
      :text-align: center

      .. image:: /_static/index_getting_started.svg
         :width: 100px

      Getting started
      ^^^^^^^^^^^^^^^
      Check out the getting started guides. They contain an
      introduction to the  main concepts and links to additional tutorials.
      +++

      .. button-ref:: getting_started/index
         :expand:
         :color: secondary
         :click-parent:


   .. grid-item-card:: User guide
      :text-align: center

      .. image:: /_static/index_user_guide.svg
         :width: 100px

      User guide
      ^^^^^^^^^^
      The user guide provides in-depth information on the
      key concepts with useful background information and explanation.
      +++

      .. button-ref:: user_guide/index
         :expand:
         :color: secondary
         :click-parent:

   .. grid-item-card:: API reference
      :text-align: center

      .. image:: /_static/index_api.svg
         :width: 100px

      API reference
      ^^^^^^^^^^^^^
      The reference guide contains a detailed description of
      the API. The reference describes how the methods work and which parameters can
      be used. It assumes that you have an understanding of the key concepts.
      +++

      .. button-ref:: src/modules
         :expand:
         :color: secondary
         :click-parent:

   .. grid-item-card:: Developer guide
      :text-align: center

      .. image:: /_static/index_contribute.svg
         :width: 100px

      Developer guide
      ^^^^^^^^^^^^^^^
      Saw a typo in the documentation? Want to improve
      existing functionalities? The contributing guidelines will guide
      you through the process of improving the project.
      +++

      .. button-ref:: developer_guide/contributing
         :expand:
         :color: secondary
         :click-parent:


.. toctree::
   :maxdepth: 1
   :caption: Contents:

   getting_started/index
   user_guide/index
   developer_guide/contributing
   src/modules

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`