Restructuring of the documentation

doc/_static/css/custom.css

@@ -0,0 +1,18 @@
+:root {
+
+    .navbar-brand {
+        height: 7rem;
+        max-height: 7rem;
+    }
+
+}
+
+.bd-page-width {
+    max-width: 98rem;
+}
+
+
+html {
+    --pst-font-size-base: 18px;
+    --pst-header-height: 7rem;
+}

doc/api/index.rst

@@ -0,0 +1 @@
+Could be nice to have an API section homepage

doc/conf.py

@@ -123,12 +123,26 @@
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = "sphinx_book_theme"
+html_theme = "pydata_sphinx_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 = {}
+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",
+        }
+    ],
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
@@ -154,6 +168,9 @@
 # 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'

doc/development/index.rst

@@ -0,0 +1,7 @@
+====================
+Developer guide
+====================
+
+Landing page of the Development section
+
+Introduce the section and links to all Development guides

doc/getting-started/index.rst

@@ -0,0 +1,8 @@
+===================
+Getting started
+===================
+
+Landing page of Getting Started section
+
+
+Should give the very brief info on how to install and links towards the slightly more detailled pages

doc/index.rst

@@ -47,73 +47,15 @@ Jump right in:
    with CLIMADA. If not, see https://www.gnu.org/licenses/.
 
 
-.. toctree::
-   :hidden:
-
-   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>
+   Getting started <getting-started/index>
+   User Guide <user-guide/index>
+   Development <development/index>
+   API <api/index>
+   Authors <misc/AUTHORS>
    Changelog <misc/CHANGELOG>
-   List of Authors <misc/AUTHORS>
-   Contribution Guide <misc/CONTRIBUTING>
-   misc/citation
+   Contribute <misc/CONTRIBUTING>
+   CLIMADA Petals <https://climada-petals.readthedocs.io/en/stable/>
+   Weather and Climate Risks Group <https://wcr.ethz.ch/>

doc/misc/AUTHORS.md

@@ -1 +1 @@
-../../AUTHORS.md
+../../AUTHORS.md

doc/misc/CHANGELOG.md

@@ -1 +1 @@
-../../CHANGELOG.md
+../../CHANGELOG.md

doc/misc/CONTRIBUTING.md

@@ -1 +1 @@
-../../CONTRIBUTING.md
+../../CONTRIBUTING.md

doc/user-guide/index.rst

@@ -0,0 +1,7 @@
+===================
+User guide
+===================
+
+Landing page of User guide
+
+Introduce the tutorials and links to them