Separate ESMValTool and ESMValCore documentation

doc/sphinx/source/_static/custom.css

@@ -44,3 +44,7 @@
 .gallery figure span.caption-number {
     display: none;
 }
+
+figure.transparent img {
+    background-color: transparent;
+}

doc/sphinx/source/_templates/cross_proj_navbar.html

@@ -0,0 +1,27 @@
+{# Displays links to the top-level TOCtree elements, in the header navbar. #}
+{% set href = pathto(root_doc) %}
+<nav>
+  <ul class="bd-navbar-elements navbar-nav">
+    {# { generate_header_nav_html(n_links_before_dropdown=theme_header_links_before_dropdown, dropdown_text=theme_header_dropdown_text) } #}
+        <li class="nav-item current active">
+            <a class="nav-link nav-internal" href="{{ href }}">
+            {{ (" ESMValTool ") }}
+            </a>
+        </li>
+        <li class="nav-item ">
+            <a class="nav-link nav-external" href="https://docs.esmvaltool.org/projects/ESMValCore/en/latest/index.html">
+             ESMValCore
+            </a>
+        </li>
+        <li class="nav-item ">
+            <a class="nav-link nav-external" href="https://tutorial.esmvaltool.org/">
+            Tutorial
+            </a>
+        </li>
+        <li class="nav-item ">
+            <a class="nav-link nav-external" href="https://esmvaltool.org/">
+            Web site
+            </a>
+        </li>
+  </ul>
+</nav>

doc/sphinx/source/_templates/layout.html

@@ -19,7 +19,9 @@
 
 <style>
 table, th, td {
-  padding: 5px;
+  /* padding: 5px; */
+  padding-left: 30px;
+  padding-right: 30px;
 }
 table {
   border-spacing: 5px;

doc/sphinx/source/_templates/sidebar_nav_lv1.html

@@ -0,0 +1,17 @@
+{# Displays the TOC-subtree for pages nested under the currently active top-level TOCtree element. EDITED #}
+<nav class="bd-docs-nav bd-links"
+     aria-label="{{ _('Section Navigation') }}">
+  <p class="bd-links__title" role="heading" aria-level="1">{{ _("Documentation Navigation") }}</p>
+  <div class="bd-toc-item navbar-nav">
+    {{- generate_toctree_html(
+      startdepth=0,
+      kind="sidebar",
+      show_nav_level=theme_show_nav_level | int,
+      maxdepth=theme_navigation_depth | int,
+      collapse=theme_collapse_navigation | tobool,
+      includehidden=theme_sidebar_includehidden | tobool,
+      titles_only=True
+      )
+    -}}
+  </div>
+</nav>

doc/sphinx/source/conf.py

@@ -180,6 +180,8 @@
         "image_light": "figures/ESMValTool-logo-2.png",
         "image_dark": "figures/ESMValTool-logo-2-dark.png",
     },
+    "navbar_center": ["cross_proj_navbar"],
+    "search_bar_text": "Search TOOL docs... (Also try search in ESMValCORE docs)",
 }
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
@@ -224,7 +226,9 @@
 # html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-# html_sidebars = {}
+html_sidebars = {
+    "**": ["sidebar_nav_lv1", "sidebar-ethical-ads"]
+}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
@@ -498,7 +502,3 @@
 }
 
 # -- Custom Document processing ----------------------------------------------
-
-import gensidebar
-
-gensidebar.generate_sidebar(globals(), "esmvaltool")

doc/sphinx/source/index.rst

@@ -1,3 +1,5 @@
+:html_theme.sidebar_secondary.remove:
+
 .. ESMValTool documentation master file, created by
    sphinx-quickstart on Tue Jun  2 11:34:13 2015.
    You can adapt this file completely to your liking, but it should at least
@@ -6,12 +8,37 @@
 Welcome to ESMValTool's documentation!
 ======================================
 
+**ESMValTool** is a community diagnostics and performance metrics tool for the evaluation of Earth System Models (ESMs) that allows for
+routine comparison of models and observations. It includes a large collection of community recipes and observation data formatters to CMOR standards.
+
+**ESMValCore** is a software package which provides the core functionality for ESMValTool. It is a workflow to find CMIP data, and apply
+commonly used pre-processing functions.
+
 To get a first impression of what ESMValTool and ESMValCore can do for you,
 have a look at our blog posts
 `Analysis-ready climate data with ESMValCore <https://blog.esciencecenter.nl/easy-ipcc-powered-by-esmvalcore-19a0b6366ea7>`_
 and
 `ESMValTool: Recipes for solid climate science <https://blog.esciencecenter.nl/esmvaltool-recipes-for-solid-climate-science-da5b33814f69>`_.
 
+
+Basic documentation schema
+--------------------------
+This gives a brief idea of topics in each of the packages to help find information. As ESMValTool encompasses ESMValCore there will be some overlap between them.
+For more detailed information, see documentation navigation to the left. Please also see
+`ESMValCore documentation <https://docs.esmvaltool.org/projects/ESMValCore/en/latest/index.html>`_. ESMValCore can be used without ESMValTool such as in Jupyter
+notebooks.
+
+.. container::
+   :name: figarch
+
+   .. figure:: figures/ESMValSchemaDiagram.png
+      :alt: Brief topics for tool and core.
+      :figclass: align-center, transparent
+
+
+Learning resources:
+-------------------
+
 A tutorial is available on https://tutorial.esmvaltool.org.
 
 A series of video lectures has been created by `ACCESS-NRI <https://access-nri.org.au>`_.
@@ -21,16 +48,36 @@ While these are tailored for ACCESS users, they are still very informative.
 
    <iframe width="560" height="315" src="https://www.youtube.com/embed/videoseries?si=pUXrXB8C8bLRfQHY&amp;list=PLFjfi2xLaFpJp59LvDc1upQsj_xzFlFLc" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
 
-|
+How to contribute
+-----------------
+Refer to ESMValTool :ref:`contributing to the community<community>` for a guide on contributing recipes and diagnostics.
+
+Refer to ESMValCore contributing for information on contributing code.
 
-For more detailed information, the documentation is available below.
+Get in touch!
+-------------
+Contact information is available :ref:`here <Support-and-Contact>`.
 
-Get in touch! Contact information is available :ref:`here <Support-and-Contact>`.
+.. toctree::
+   :hidden:
+   :maxdepth: 2
+   :caption: ESMValTool
 
-.. include:: _sidebar.rst.inc
+    Introduction <introduction>
+    ESMValTool Functionalities <functionalities>
+    Gallery <gallery>
+    Getting started <quickstart/index>
+    Recipes <recipes/index>
+    Diagnostics API Reference <api/esmvaltool>
+    Obtaining input data <input>
+    Making a recipe or diagnostic <develop/index>
+    Contributing to the community <community/index>
+    Utilities <utils/utils>
+    Frequently Asked Questions <faq>
+    Changelog <changelog>
 
 Indices and tables
-==================
+------------------
 
 * :ref:`genindex`
 * :ref:`search`