More style change

OGGM · Mar 26, 2021 · 5253fd4 · 5253fd4
1 parent 7df2172
commit 5253fd4
Show file tree

Hide file tree

Showing 22 changed files with 109 additions and 136 deletions.
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -1,20 +1,20 @@
-.rst-content .toggle {
-    background: none repeat scroll 0 0 #e7f2fa;
+.toggle {
+    background: none repeat scroll 0 0;
     padding: 12px;
     line-height: 24px;
     margin-bottom: 24px;
 }
 
-.rst-content .toggle .admonition-title {
+.toggle .admonition-title {
     display: block;
     clear: both;
     cursor: pointer;
 }
 
-.rst-content .toggle .admonition-title:after {
+.toggle .admonition-title:after {
     content: " ▶";
 }
 
-.rst-content .toggle .admonition-title.open:after {
+.toggle .admonition-title.open:after {
     content: " ▼";
 }
diff --git a/docs/_static/style.css b/docs/_static/style.css
diff --git a/docs/activity_sheets/as_gallery.rst b/docs/activity_sheets/as_gallery.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _as_gallery:
 
 Lesson plan 1: Glacier Gallery

diff --git a/docs/activity_sheets/as_simulator.rst b/docs/activity_sheets/as_simulator.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _as_simulator:
 
 Lesson plan 3: Glacier Simulator

diff --git a/docs/classes_howto.rst b/docs/classes_howto.rst
@@ -13,8 +13,6 @@ high school level (using the web applications) and at the university level
 (using the programmable notebooks). You will find some help to get you started
 below.
 
-See also :ref:`examples` for existing classes based on OGGM-Edu.
-
 Using the OGGM-Edu web apps at the highschool level
 ---------------------------------------------------
 
@@ -73,3 +71,16 @@ even trying to analyse the plot they just produced.
 If you have the chance to have more experienced students in the room,
 **organize peer-mentoring in groups of 2 or 3**. Students are often better
 in mentoring each other than we are.
+
+
+Implementation
+--------------
+
+Ready to give it a go? You will find more information in the pages below:
+
+.. toctree::
+    :maxdepth: 1
+
+    examples.rst
+    user_content.rst
+    technical_details.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -144,6 +144,17 @@
 # a list of builtin themes.
 html_theme = 'sphinx_book_theme'
 
+
+extra_navbar = """<p align="left"><strong>License</strong></p>
+<p align="left">
+<a href="default.asp">
+  <img alt="https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by.svg" src="https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by.svg">
+</a> 
+</p>
+<p align="left">Unless specified otherwise, the content of OGGM-Edu is shared 
+under a <a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International</a> license.</p>
+"""
+
 # 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.
@@ -155,8 +166,14 @@
     "path_to_docs": "docs",
     "home_page_in_toc": True,
     "toc_title": "On this page",
+    "extra_navbar": extra_navbar,
+}
+
+html_sidebars = {
+    "**": ["sidebar-search-bs.html", "sbt-sidebar-nav.html", "sbt-sidebar-footer.html"]
 }
 
+
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
 
@@ -181,6 +198,8 @@
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
+html_css_files = ['custom.css']
+
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
 # directly to the root of the documentation.
@@ -308,8 +327,8 @@
 #  dir menu entry, description, category)
 texinfo_documents = [
     (master_doc, 'OGGM-Edu', u'OGGM-Edu Documentation',
-     author, 'OGGM-Edu', 'One line description of project.',
-     'Miscellaneous'),
+     author, 'OGGM-Edu', 'OGGM-Edu is an educational website about glaciers.',
+     'Education'),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -335,7 +354,7 @@
 with open("epilog.rst", "r") as myfile:
     rst_epilog = myfile.read()
 
-# Add toggle container https://stackoverflow.com/questions/2454577/sphinx-restructuredtext-show-hide-code-snippets
+
+# Add toggle container
 def setup(app):
-    app.add_stylesheet('custom.css')
     app.add_config_value('READTHEDOCS_LANGUAGE', '', READTHEDOCS_LANGUAGE)
diff --git a/docs/environment.yml b/docs/environment.yml
@@ -2,8 +2,10 @@ name: edudocs
 channels:
   - conda-forge
 dependencies:
-  - python=3.7
+  - python
   - numpydoc
   - ipython
   - sphinx
-  - sphinx-book-theme
+  - pip
+  - pip:
+      - sphinx-book-theme
diff --git a/docs/epilog.rst b/docs/epilog.rst
@@ -1,11 +0,0 @@
-|
-
-**License**
-
-.. image:: https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by.svg
-  :target: https://creativecommons.org/licenses/by/4.0
-
-*Unless specified otherwise (e.g. certain images, links...), the content of this
-page is shared under a*
-`Creative Commons Attribution 4.0 International <https://creativecommons.org/licenses/by/4.0/>`_
-*license (CC BY 4.0).*

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -1,7 +1,7 @@
 .. _examples:
 
-Application examples
-====================
+Classes based on OGGM-Edu
+=========================
 
 This page lists some known applications of OGGM-Edu in classes. You can
 use them "as is", or as templates for your own classes. We would love to hear
@@ -25,11 +25,8 @@ high school student who did an internship with us. They and have not yet
 been tested in class. Feel free to adapt from them, and send us your
 suggestions!
 
-.. toctree::
-    :maxdepth: 1
-
-    activity_sheets/as_gallery.rst
-    activity_sheets/as_simulator.rst
+- :ref:`as_gallery`
+- :ref:`as_simulator`
 
 We don't have examples for the Glacier Explorer app yet. Send us some! Or
 check out `this twitter thread <https://twitter.com/OGGM_org/status/1359450122451619842>`_

diff --git a/docs/explorer.rst b/docs/explorer.rst
@@ -142,7 +142,7 @@ need one to download the app, display the logos and the map).
 
 To start the app locally, all you'll need is to
 have `Docker <https://www.docker.com/>`_ installed on your computer.
-From there, run this command into a terminal:
+From there, run this command into a terminal::
 
     docker run -e BOKEH_ALLOW_WS_ORIGIN=127.0.0.1 -p 8080:80 oggm/bokeh:20191210 git+https://github.com/OGGM/world-glacier-explorer.git app.ipynb
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -84,14 +84,7 @@ background in programming, and we are working to make them as accessible as
 possible. Read our :ref:`notebooks_howto` first if you are new to these things.
 
 * :doc:`notebooks_howto`
-* :doc:`notebooks_flowline_intro`
-* :doc:`notebooks_ice_flow_parameters`
-* :doc:`notebooks_surging_glaciers`
-* :doc:`notebooks_mass_balance_gradient`
-* :doc:`notebooks_temperature_index_models`
-* :doc:`notebooks_accumulation_and_ablation`
-* :doc:`notebooks_advance_and_retreat`
-* :doc:`notebooks_real_glacier_simulations`
+* :doc:`notebooks_index`
 
 
 .. toctree::
@@ -100,14 +93,8 @@ possible. Read our :ref:`notebooks_howto` first if you are new to these things.
     :caption: Interactive Notebooks
 
     notebooks_howto.rst
-    notebooks_flowline_intro.rst
-    notebooks_ice_flow_parameters.rst
-    notebooks_surging_glaciers.rst
-    notebooks_mass_balance_gradient.rst
-    notebooks_temperature_index_models.rst
-    notebooks_accumulation_and_ablation.rst
-    notebooks_advance_and_retreat.rst
-    notebooks_real_glacier_simulations.rst
+    notebooks_index.rst
+
 
 .. _title_tuto:
 
@@ -134,9 +121,6 @@ recommendations and guidelines here.
 * :doc:`why_oggmedu`
 * :doc:`classes_howto`
 * :doc:`examples`
-* :doc:`user_content`
-* :doc:`technical_details`
-* :doc:`other_resources`
 * :doc:`charter`
 * :doc:`roadmap`
 
@@ -147,9 +131,6 @@ recommendations and guidelines here.
 
     why_oggmedu.rst
     classes_howto.rst
-    examples.rst
-    user_content.rst
-    technical_details.rst
     other_resources.rst
     charter.rst
     roadmap.rst
@@ -194,24 +175,26 @@ also had support from various sources:
 .. raw:: html
 
     <a href="https://www.uibk.ac.at/foerderkreis1669/" >
-    <img src="_static/logo_1669_uibk.jpg" alt="Image missing" width="49%" />
+    <img src="_static/logo_1669_uibk.jpg" alt="Image missing" width="40%" />
     </a>
     <a href="https://www.bmbf.de/en/index.html" >
-    <img src="_static/logo_bmbf.jpg" alt="Image missing" width="49%" />
+    <img src="_static/logo_bmbf.jpg" alt="Image missing" width="40%" />
     </a>
     <a href="https://cloud.google.com/data-solutions-for-change" >
-    <img src="_static/feature-google-for-nonprofits-logo.svg" alt="Image missing" width="49%" />
+    <img src="_static/feature-google-for-nonprofits-logo.svg" alt="Image missing" width="40%" />
     </a>
     <a href="http://holoviz.org/" >
-    <img src="https://discourse.holoviz.org/uploads/default/original/1X/59aba5e11167d6b8742e01fc9d6bb60ddd4df55e.png" alt="Image missing" width="49%" />
+    <img src="https://discourse.holoviz.org/uploads/default/original/1X/59aba5e11167d6b8742e01fc9d6bb60ddd4df55e.png" alt="Image missing" width="40%" />
     </a>
     <a href="https://jupyter.org" >
-    <img src="https://jupyter.org/assets/hublogo.svg" alt="Jupyter logo" width="49%" />
+    <img src="https://jupyter.org/assets/hublogo.svg" alt="Jupyter logo" width="40%" />
     </a>
     <a href="https://mybinder.org" >
-    <img src="https://mybinder.org/static/logo.svg" alt="MyBinder logo" width="49%" />
+    <img src="https://mybinder.org/static/logo.svg" alt="MyBinder logo" width="40%" />
     </a>
+    <br>
 
+|
 
 We rely on awesome open source tools to run OGGM-Edu! Most notably:
 

diff --git a/docs/notebooks_accumulation_and_ablation.rst → docs/notebooks/accumulation_and_ablation.rst b/docs/notebooks_accumulation_and_ablation.rst → docs/notebooks/accumulation_and_ablation.rst
@@ -3,7 +3,7 @@
 Accumulation, ablation and glacier mass balance
 ===============================================
 
-.. figure:: _static/intro_acc_abl.png
+.. figure:: ../_static/intro_acc_abl.png
 
 	Figure: Schematic representation of glacier mass balance as the sum of accumulation and ablation.
 

diff --git a/docs/notebooks_advance_and_retreat.rst → docs/notebooks/advance_and_retreat.rst b/docs/notebooks_advance_and_retreat.rst → docs/notebooks/advance_and_retreat.rst
@@ -3,7 +3,7 @@
 Glacier advance and retreat
 ===============================================
 
-.. figure:: _static/intro_advance_retreat.png
+.. figure:: ../_static/intro_advance_retreat.png
 
 	Figure: Glacier advance (retreat) as a result of a decrease (increase) in the equilibrium line altitude.
 

diff --git a/docs/notebooks_flowline_intro.rst → docs/notebooks/flowline_intro.rst b/docs/notebooks_flowline_intro.rst → docs/notebooks/flowline_intro.rst
@@ -3,7 +3,7 @@
 Glacier flowline modelling
 ==========================
 
-.. figure:: _static/intro_fig_flowline.png
+.. figure:: ../_static/intro_fig_flowline.png
 
     Figure: Geometry of a glacier model after 500 years, that moves only from deformation processes.
 

diff --git a/docs/notebooks_ice_flow_parameters.rst → docs/notebooks/ice_flow_parameters.rst b/docs/notebooks_ice_flow_parameters.rst → docs/notebooks/ice_flow_parameters.rst
@@ -3,8 +3,7 @@
 Ice flow parameters
 ===================
 
-.. figure::  _static/intro_fig_iceflow_parameters.png
-    :width: 70%
+.. figure::  ../_static/intro_fig_iceflow_parameters.png
 
     Figure: Geometry of glacier models after 1500 years.  Blue graph: glacier moves by deformation, orange graph: glacier that slides also.
 

diff --git a/docs/notebooks_mass_balance_gradient.rst → docs/notebooks/mass_balance_gradient.rst b/docs/notebooks_mass_balance_gradient.rst → docs/notebooks/mass_balance_gradient.rst
@@ -3,11 +3,12 @@
 Mass balance gradient
 =====================
 
-.. figure:: _static/intro_fig_MBG.png
+.. figure:: ../_static/intro_fig_MBG.png
 
     Left figure: Behaviour of different mass balance gradients. Right figure: Geometry of glaciers with different mass balance gradients after 300 years.
 
-In this notebook you will run experiments with a focus on the mass balance gradient. You will see how different mass balance gradients influence the growth of a glacier. Therefore, we calculate our glacier models until they reach an equilibrium state and compare length, area and volume. In addition, we will calculate the volume response times of the glacier models to small climatic changes.
+In this notebook you will run experiments with a focus on the mass balance gradient.
+You will see how different mass balance gradients influence the growth of a glacier. Therefore, we calculate our glacier models until they reach an equilibrium state and compare length, area and volume. In addition, we will calculate the volume response times of the glacier models to small climatic changes.
 
 Open this experiment in your browser with the button below:
 

diff --git a/docs/notebooks_real_glacier_simulations.rst → docs/notebooks/real_glacier_simulations.rst b/docs/notebooks_real_glacier_simulations.rst → docs/notebooks/real_glacier_simulations.rst
@@ -3,7 +3,7 @@
 Glaciers as water resources
 ===========================
 
-.. figure:: _static/intro_glacier_water_volume_seasonality.png
+.. figure:: ../_static/intro_glacier_water_volume_seasonality.png
 
 	Figure: Annual cycle of glacier water volume change during the glacier retreat phase (blue) and in equilibrium state (orange).