Revert "Merge branch 'feature/documentation-restructuring' into develop"

This reverts commit 75481ee, reversing changes made to 68a51e1.
CLIMADA-project · Nov 14, 2024 · b8cc3c4 · b8cc3c4
1 parent 75481ee
commit b8cc3c4
Show file tree

Hide file tree

Showing 24 changed files with 71 additions and 124 deletions.
diff --git a/doc/_static/css/custom.css b/doc/_static/css/custom.css
diff --git a/doc/api/index.rst b/doc/api/index.rst
diff --git a/doc/api/climada/climada.engine.rst → doc/climada/climada.engine.rst b/doc/api/climada/climada.engine.rst → doc/climada/climada.engine.rst
diff --git a/doc/api/climada/climada.engine.unsequa.rst → doc/climada/climada.engine.unsequa.rst b/doc/api/climada/climada.engine.unsequa.rst → doc/climada/climada.engine.unsequa.rst
diff --git a/...api/climada/climada.entity.disc_rates.rst → doc/climada/climada.entity.disc_rates.rst b/...api/climada/climada.entity.disc_rates.rst → doc/climada/climada.entity.disc_rates.rst
diff --git a/...imada/climada.entity.exposures.litpop.rst → ...imada/climada.entity.exposures.litpop.rst b/...imada/climada.entity.exposures.litpop.rst → ...imada/climada.entity.exposures.litpop.rst
diff --git a/doc/api/climada/climada.entity.exposures.rst → doc/climada/climada.entity.exposures.rst b/doc/api/climada/climada.entity.exposures.rst → doc/climada/climada.entity.exposures.rst
diff --git a/...i/climada/climada.entity.impact_funcs.rst → doc/climada/climada.entity.impact_funcs.rst b/...i/climada/climada.entity.impact_funcs.rst → doc/climada/climada.entity.impact_funcs.rst
diff --git a/doc/api/climada/climada.entity.measures.rst → doc/climada/climada.entity.measures.rst b/doc/api/climada/climada.entity.measures.rst → doc/climada/climada.entity.measures.rst
diff --git a/doc/api/climada/climada.entity.rst → doc/climada/climada.entity.rst b/doc/api/climada/climada.entity.rst → doc/climada/climada.entity.rst
diff --git a/doc/api/climada/climada.hazard.centroids.rst → doc/climada/climada.hazard.centroids.rst b/doc/api/climada/climada.hazard.centroids.rst → doc/climada/climada.hazard.centroids.rst
diff --git a/doc/api/climada/climada.hazard.rst → doc/climada/climada.hazard.rst b/doc/api/climada/climada.hazard.rst → doc/climada/climada.hazard.rst
diff --git a/...i/climada/climada.hazard.trop_cyclone.rst → doc/climada/climada.hazard.trop_cyclone.rst b/...i/climada/climada.hazard.trop_cyclone.rst → doc/climada/climada.hazard.trop_cyclone.rst
diff --git a/doc/api/climada/climada.rst → doc/climada/climada.rst b/doc/api/climada/climada.rst → doc/climada/climada.rst
diff --git a/doc/api/climada/climada.util.calibrate.rst → doc/climada/climada.util.calibrate.rst b/doc/api/climada/climada.util.calibrate.rst → doc/climada/climada.util.calibrate.rst
diff --git a/doc/api/climada/climada.util.rst → doc/climada/climada.util.rst b/doc/api/climada/climada.util.rst → doc/climada/climada.util.rst
diff --git a/doc/conf.py b/doc/conf.py
@@ -40,7 +40,6 @@
     "sphinx.ext.viewcode",
     "sphinx.ext.napoleon",
     "sphinx.ext.ifconfig",
-    "sphinx_design",
     "myst_nb",
     "sphinx_markdown_tables",
     "readthedocs_ext.readthedocs",
@@ -124,26 +123,12 @@
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = "pydata_sphinx_theme"
+html_theme = "sphinx_book_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-html_theme_options = {
-    "header_links_before_dropdown": 7,
-    "icon_links": [
-        {
-            # Label for this link
-            "name": "GitHub",
-            # URL where the link will redirect
-            "url": "https://github.com/CLIMADA-project",  # required
-            # Icon class (if "type": "fontawesome"), or path to local image (if "type": "local")
-            "icon": "fa-brands fa-square-github",
-            # The type of image to be used (see below for details)
-            "type": "fontawesome",
-        }
-    ],
-}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
@@ -169,9 +154,6 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
-html_css_files = [
-    "css/custom.css",
-]
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
 # html_last_updated_fmt = '%b %d, %Y'

diff --git a/doc/development/index.rst b/doc/development/index.rst
diff --git a/doc/getting-started/index.rst b/doc/getting-started/index.rst
diff --git a/doc/index.rst b/doc/index.rst
@@ -48,14 +48,72 @@ Jump right in:
 
 
 .. toctree::
-   :maxdepth: 1
+   :hidden:
 
-   Getting started <getting-started/index>
-   User Guide <user-guide/index>
-   Development <development/index>
-   API <api/index>
-   Authors <misc/AUTHORS>
-   Changelog <misc/CHANGELOG>
-   Contribute <misc/CONTRIBUTING>
+   GitHub Repositories <https://github.com/CLIMADA-project>
    CLIMADA Petals <https://climada-petals.readthedocs.io/en/stable/>
    Weather and Climate Risks Group <https://wcr.ethz.ch/>
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: User Guide
+   :hidden:
+
+   guide/Guide_Introduction
+   Getting Started <guide/Guide_get_started>
+   guide/install
+   Running CLIMADA on Euler <guide/Guide_Euler>
+
+
+.. toctree::
+   :caption: API Reference
+   :hidden:
+
+   Python Modules <climada/climada>
+
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Tutorials
+   :hidden:
+
+   Overview <tutorial/1_main_climada>
+   Python Introduction <tutorial/0_intro_python>
+   Hazard <tutorial/hazard>
+   Exposures <tutorial/exposures>
+   Impact <tutorial/impact>
+   Uncertainty Quantification <tutorial/unsequa>
+   tutorial/climada_engine_Forecast
+   tutorial/climada_util_calibrate
+   Google Earth Engine <tutorial/climada_util_earth_engine>
+   tutorial/climada_util_api_client
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Developer Guide
+   :hidden:
+
+   Development with Git <guide/Guide_Git_Development>
+   guide/Guide_CLIMADA_Tutorial
+   guide/Guide_Configuration
+   guide/Guide_Testing
+   guide/Guide_continuous_integration_GitHub_actions
+   guide/Guide_Review
+   guide/Guide_PythonDos-n-Donts
+   guide/Guide_Exception_Logging
+   Performance and Best Practices <guide/Guide_Py_Performance>
+   CLIMADA Coding Conventions <guide/Guide_CLIMADA_conventions>
+   Building the Documentation <README>
+
+
+.. toctree::
+   :caption: Miscellaneous
+   :hidden:
+
+   README <misc/README>
+   Changelog <misc/CHANGELOG>
+   List of Authors <misc/AUTHORS>
+   Contribution Guide <misc/CONTRIBUTING>
+   misc/citation
diff --git a/doc/misc/AUTHORS.md b/doc/misc/AUTHORS.md
@@ -1 +1 @@
-../../AUTHORS.md
+../../AUTHORS.md
diff --git a/doc/misc/CHANGELOG.md b/doc/misc/CHANGELOG.md
@@ -1 +1 @@
-../../CHANGELOG.md
+../../CHANGELOG.md
diff --git a/doc/misc/CONTRIBUTING.md b/doc/misc/CONTRIBUTING.md
@@ -1 +1 @@
-../../CONTRIBUTING.md
+../../CONTRIBUTING.md
diff --git a/doc/user-guide/index.rst b/doc/user-guide/index.rst