Improvinf the documentation

doc/conf.py

@@ -40,7 +40,7 @@
 
 html_theme = "pydata_sphinx_theme"
 html_theme_options = {
-    "gitlab_url": "https://gitlab.ecoco2.com/recherche/computation_toolbox",
+    "github_url": "https://github.com/GreenForecast-Squad/energetic-stress-production",
     "announcement": f"<p>Last version is v{version}</p>",
 }
 html_static_path = ['_static']
@@ -51,7 +51,7 @@
 # If true, '()' will be appended to :func: etc. cross-reference text.
 add_function_parentheses = False
 
-html_title = f"{project} v{version} Manual"
+html_title = f"{project} v{version}"
 
 
 # -- nbsphinx extension configuration ------------------------------------------

doc/developer_guide/contributing.rst

@@ -0,0 +1,11 @@
+How to contribute
+=================
+
+Want to contribute ? Have an idea or special need ? Head to the
+`issue tracker`_ to get a feeling of what is planned and, better `open a new issue`_
+to explain what you want or need to do.
+
+
+
+.. _issue tracker: https://github.com/GreenForecast-Squad/energetic-stress-production/issues
+.. _open a new issue: https://github.com/GreenForecast-Squad/energetic-stress-production/issues/new

doc/getting_started/index.rst

@@ -0,0 +1,15 @@
+Getting Started
+===============
+
+Installation
+------------
+
+
+Use Hatch to install the package.
+
+
+Examples of use
+===============
+
+See the tutorials in the
+:doc:`../user_guide/index` !

doc/index.rst

@@ -6,11 +6,92 @@
 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: 2
+   :maxdepth: 1
    :caption: Contents:
 
-
+   getting_started/index
+   user_guide/index
+   developer_guide/contributing
    src/modules
 
 Indices and tables

doc/src/modules.rst

@@ -1,5 +1,5 @@
-energy_forecast
-===============
+API reference
+=============
 
 .. toctree::
    :maxdepth: 4

doc/user_guide/index.rst

@@ -0,0 +1,13 @@
+User Guide
+==========
+Interested in learning more about the project ?
+
+Check the notebooks below to get started
+on specific topics, or head over to the :doc:`../src/modules` for a complete overview
+of the package.
+
+.. toctree::
+    :maxdepth: 3
+    :caption: Common use cases
+
+    notebooks/index

doc/user_guide/notebooks/index.ipynb

@@ -0,0 +1,23 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Example notebook"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": []
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}