Add logo to rtd sidebar

rl-institut · Aug 10, 2023 · d5d0a63 · d5d0a63
1 parent 34619a6
commit d5d0a63
Show file tree

Hide file tree

Showing 6 changed files with 5 additions and 5 deletions.
diff --git a/docs/source/_static/SimBA_logo.png → docs/source/_images/SimBA_logo.png b/docs/source/_static/SimBA_logo.png → docs/source/_images/SimBA_logo.png
diff --git a/.../source/_static/SimBA_module_overview.png → .../source/_images/SimBA_module_overview.png b/.../source/_static/SimBA_module_overview.png → .../source/_images/SimBA_module_overview.png
diff --git a/docs/source/_static/run_overview.png → docs/source/_images/run_overview.png b/docs/source/_static/run_overview.png → docs/source/_images/run_overview.png
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -45,7 +45,7 @@
 numfig = True
 # Add any paths that contain templates here, relative to this directory.
 templates_path = []
-
+html_logo = "./_images/SimBA_logo.png"
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.

diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst
@@ -47,7 +47,7 @@ General Concept
 SimBA is designed as a toolbox, so the specific use can be adapted to the users needs. Its core functionality is to run scenario based simulations. A scenario is defined by a set of input files. Next to the simulation mode, several optimization modes exist, that can be linked and executed consecutively.
 
 .. _figure_simba_modules:
-.. figure:: _static/SimBA_module_overview.png
+.. figure:: _images/SimBA_module_overview.png
     :alt:  figure_simba_modules
     :width: 600
 
@@ -65,7 +65,7 @@ As a result of each simulation the energy demand at each electrified station, th
 In case an optimization is carried out, the results are then analyzed, the optimizer adapts the input data and parameters and starts the process again with the trip consumption analysis. In which order and for what purpose the individual modules are executed is mainly defined using the different modes. These modes can be used to manipulate the defined scenario e.g. by altering bus types from depot to opportunity chargers, optimize sets of rotations to increase electrification or suggest stations for electrification by minimizing the amount of stations needed. You can learn more about the modes  :ref:`here <sim_modes>`.
 
 .. _simba_default_plot:
-.. figure:: _static/run_overview.png
+.. figure:: _images/run_overview.png
     :alt:  simba_default_plot
     :width: 600
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,11 +3,11 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-.. image:: _static/SimBA_Logo.png
+
+.. image:: ./_images/SimBA_Logo.png
     :alt:  SimBA_Logo
     :width: 200
 
-
 Welcome to the SimBA documentation!
 ===================================