Trying to fix API docs

dataforgoodfr · Jul 1, 2024 · ea40537 · ea40537
1 parent 156d414
commit ea40537
Show file tree

Hide file tree

Showing 11 changed files with 12 additions and 13 deletions.
diff --git a/doc/src/energy_forecast.dashboard.Accueil.rst b/doc/src/energy_forecast.dashboard.Accueil.rst
@@ -1,4 +1,4 @@
-energy\_forecast.dashboard.Accueilt module
+energy\_forecast.dashboard.Accueil module
 ======================================================
 
 .. automodule:: energy_forecast.dashboard.Accueil

diff --git a/doc/src/energy_forecast.dashboard.pages.1_Météo.rst b/doc/src/energy_forecast.dashboard.pages.1_Météo.rst
@@ -1,5 +1,5 @@
 energy\_forecast.dashboard.pages.1\_Météo module
-==================================================
+================================================
 
 .. automodule:: energy_forecast.dashboard.pages.1_Météo
    :members:

diff --git a/doc/src/energy_forecast.dashboard.pages.2_Production.rst b/doc/src/energy_forecast.dashboard.pages.2_Production.rst
@@ -1,5 +1,5 @@
 energy\_forecast.dashboard.pages.2\_Production module
-============================================================
+=====================================================
 
 .. automodule:: energy_forecast.dashboard.pages.2_Production
    :members:

diff --git a/doc/src/energy_forecast.dashboard.pages.3_Consommation.rst b/doc/src/energy_forecast.dashboard.pages.3_Consommation.rst
@@ -1,5 +1,5 @@
 energy\_forecast.dashboard.pages.3\_Consommation module
-==================================================================
+=======================================================
 
 .. automodule:: energy_forecast.dashboard.pages.3_Consommation
    :members:

diff --git a/doc/src/energy_forecast.dashboard.pages.4_Jours_Tempos.rst b/doc/src/energy_forecast.dashboard.pages.4_Jours_Tempos.rst
@@ -1,5 +1,5 @@
 energy\_forecast.dashboard.pages.4\_Jours\_Tempos module
-============================================================
+========================================================
 
 .. automodule:: energy_forecast.dashboard.pages.4_Jours_Tempos
    :members:

diff --git a/doc/src/energy_forecast.dashboard.pages.rst b/doc/src/energy_forecast.dashboard.pages.rst
@@ -10,7 +10,7 @@ Submodules
    energy_forecast.dashboard.pages.1_Météo
    energy_forecast.dashboard.pages.2_Production
    energy_forecast.dashboard.pages.3_Consommation
-   energy_forecast.dashboard.pages.4_jours_Tempos
+   energy_forecast.dashboard.pages.4_Jours_Tempos
 
 Module contents
 ---------------

diff --git a/pyproject.toml b/pyproject.toml
@@ -62,9 +62,8 @@ extra-dependencies = [
   "sphinx-gallery",
   "sphinx_design",
   "nbsphinx",
-  "taipy",
   "streamlit",
-
+  "ipython",
 ]
 [tool.hatch.envs.docs.scripts]
 build = "sphinx-build -b html doc/ doc/_build"

diff --git a/src/energy_forecast/dashboard/Accueil.py b/src/energy_forecast/dashboard/Accueil.py
@@ -1,3 +1,4 @@
+"""Landing page for the Energy Forecast dashboard."""
 import streamlit as st
 
 if __name__ == "__main__":

diff --git a/src/energy_forecast/dashboard/pages/2_Production.py b/src/energy_forecast/dashboard/pages/2_Production.py
@@ -11,7 +11,6 @@
 import altair as alt
 alt.renderers.set_embed_options(time_format_locale="fr-FR", format_locale="fr-FR")
 
-
 @memory.cache
 def compute_data_pv_power(date: str)->pd.DataFrame:
     """Estimate the power generated by solar panels.
@@ -75,8 +74,6 @@ def compute_data_eolien(date)->pd.DataFrame:
     return eolien_power
 
 
-
-
 @memory.cache
 def compute_energy(date:str):
     """Concatenate the energy production data with the predictions.

diff --git a/src/energy_forecast/dashboard/pages/3_Consommation.py b/src/energy_forecast/dashboard/pages/3_Consommation.py
@@ -9,9 +9,11 @@
 import pandas as pd
 import streamlit as st
 import altair as alt
+from energy_forecast.meteo import memory
+
 alt.renderers.set_embed_options(time_format_locale="fr-FR", format_locale="fr-FR")
 
-@st.cache
+@memory.cache
 def get_weekly_forecast(secret: str)->pd.DataFrame:
     """Get the weekly forecast for the total electricity consumption.
 

diff --git a/src/energy_forecast/dashboard/pages/__init__.py b/src/energy_forecast/dashboard/pages/__init__.py
@@ -2,4 +2,4 @@
 
 Stremlit automatically detects the different pages of the dashboard and add them to the sidebar of the main page.
 
-The main page is generated by the :mod:`src.energy_forecast.dashboard_streamlit` module."""
+The main page is generated by the :mod:`src.energy_forecast.dashboard.Accueil` module."""
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@

		Stremlit automatically detects the different pages of the dashboard and add them to the sidebar of the main page.

		The main page is generated by the :mod:`src.energy_forecast.dashboard_streamlit` module."""
		The main page is generated by the :mod:`src.energy_forecast.dashboard.Accueil` module."""