Switch to spinx book theme (#114)

OGGM · Mar 27, 2021 · 88833c6 · 88833c6
1 parent 491eaf6
commit 88833c6
Show file tree

Hide file tree

Showing 124 changed files with 1,842 additions and 5,659 deletions.
diff --git a/BUILD_HOWTO.rst b/BUILD_HOWTO.rst
@@ -21,17 +21,17 @@ Requirements
 ~~~~~~~~~~~~
 
 There are some extra requirements to build the docs: you will need to
-have ``sphinx``, ``sphinx_rtd_theme``, ``numpydoc`` and ``ipython`` installed.
+have ``sphinx``, ``sphinx-book-theme``, ``numpydoc`` and ``ipython`` installed.
 
 If you have a conda environment, you can install the extra
 requirements with::
 
-      conda install sphinx sphinx_rtd_theme ipython numpydoc sphinx-intl
+      conda install sphinx sphinx-book-theme ipython numpydoc sphinx-intl
 
 If you use pip, activate your python environment and install the requirements
 with::
 
-      pip install sphinx sphinx_rtd_theme ipython numpydoc sphinx-intl
+      pip install sphinx sphinx-book-theme ipython numpydoc sphinx-intl
 
 
 Building the documentation
@@ -67,7 +67,7 @@ Update the translation files
 OGGM-Edu is available in other languages (although almost nothing is translated yet). 
 
 Each time OGGM-Edu is updated in english, it is wize to also update the translation 
-files (`.po`) files. After a regular `make html` build, simply run the `translate.sh` 
+files (`.po`) files. After a `make html` build, simply run the `translate.sh`
 script from the same `oggm-edu/docs` folder: it will update the `.po` files 
 accordingly. 
 
@@ -77,12 +77,12 @@ Build the website in one of the available languages
 
 German::
 
-    sphinx-build -b html -D language=de . _build/de
+    sphinx-build -b html -t language_de . _build/de
 
 French::
 
-    sphinx-build -b html -D language=fr . _build/fr
+    sphinx-build -b html -t language_fr . _build/fr
 
 Spanish::
 
-    sphinx-build -b html -D language=es . _build/es
+    sphinx-build -b html -t language_es . _build/es
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/logo.png b/docs/_static/logo.png
diff --git a/docs/_static/logo_bw.png b/docs/_static/logo_bw.png
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
@@ -12,7 +14,6 @@ Lesson plan 1: Glacier Gallery
     by OGGM-Edu, students will be introduced to glaciers and their forms.
 :Objectives:
     Upon completion of this lesson, students will be able to:
-
        - Identify the standard definition of a glacier
        - Compare and contrast the four glacier types presented in the app
 :Materials Needed:

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
@@ -13,7 +15,6 @@ Lesson plan 3: Glacier Simulator
      parameters influence glacier size, and more.
 :Objectives:
     Upon completion of this lesson, students will be able to:
-
        - Recite and understand words and their definitions, most notably: Equillibrium Line Altitude (ELA), accumulation area, and glacier-mass balance.
        - Describe the correlation between glacier top width and accumulation area, ELA and equilibrium glacier size, and glacier density and gradient.
        - Discover through scientific inquiry and analysis of visual data

diff --git a/docs/alps_future.rst b/docs/alps_future.rst
@@ -32,17 +32,4 @@ Source code
 
 Code and data are on `GitHub <https://github.com/OGGM/alps_future>`_, BSD3 licensed.
 
-.. ifconfig:: READTHEDOCS_LANGUAGE == 'en'
-
-  Possible future app improvements
-  --------------------------------
-
-  - display of uncertainties into the graphic
-  - possibility to choose between absolute and percentage change of volume
-  - adding a map in which the user can select glaciers
-  - implement tick-boxes for choosing the displayed RCP-scenarios
-  - two dropdown menus to give the opportunity that every region can be compared to every other region/country
-
-  If you are interested to contribute you can send us the edited
-  `file <https://github.com/OGGM/alps_future/blob/master/app.ipynb>`_ per mail or
-  with a pull-request. Thanks!
+Possible future app improvements: see `this issue <https://github.com/OGGM/alps_future/issues/5>`_
diff --git a/docs/classes_howto.rst b/docs/classes_howto.rst
@@ -13,10 +13,8 @@ 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
----------------------------------------------------
+Using the OGGM-Edu web apps at the high school level
+----------------------------------------------------
 
 OGGM-Edu can be used to organize a 2 to 4 hours class, possibly even
 longer. It could be organized as such:
@@ -48,8 +46,8 @@ short notebook. In a second session (after an hour or so),
 summarize the usual pitfalls:
 
 - recognize that notebooks are actual files (not something magical on browser)
-- aknowledge that the order of execution of cells matter
-- aknowledge that errors in cell execution are OK and can be recovered from
+- acknowledge that the order of execution of cells matter
+- acknowledge that errors in cell execution are OK and can be recovered from
 - show how to restart with a fresh notebook
 - encourage the use of keyboard shortcuts (such as `[shift+enter]` and
   `[ctrl+m] + key`)
@@ -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 OGGM-Edu a go? You will find more information in the pages below:
+
+.. toctree::
+    :maxdepth: 1
+
+    examples.rst
+    user_content.rst
+    technical_details.rst