put docs to toc still (#170)

OGGM · Jun 28, 2022 · 1812d69 · 1812d69
1 parent bd7250a
commit 1812d69
Show file tree

Hide file tree

Showing 8 changed files with 137 additions and 79 deletions.
diff --git a/docs/api_detailed.rst b/docs/api_detailed.rst
@@ -2,13 +2,13 @@
 
 .. _api_detailed:
 
-#####################
-package documentation
-#####################
+##############################
+oggm-edu package documentation
+##############################
 
 .. currentmodule:: oggm_edu
 
-Here follows a list of the `oggm-edu` classes and their functionality. The best
+Here follows a list of the ``oggm-edu`` classes and their functionality. The best
 way to learn is to navigate between this static documentation and the
 `rendered notebooks <https://oggm.org/oggm-edu-notebooks>`_ or the interactive version on MyBinder!
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -160,6 +160,13 @@ recommendations and guidelines here.
     charter.rst
     roadmap.rst
 
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+    :caption: Package documentation
+
+    api_detailed.rst
+
 .. _title_contact:
 
 Get in touch

diff --git a/docs/locale/de/LC_MESSAGES/api_detailed.po b/docs/locale/de/LC_MESSAGES/api_detailed.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: OGGM-Edu 1.0\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2022-06-28 18:30+0200\n"
+"POT-Creation-Date: 2022-06-28 18:39+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -46,12 +46,12 @@ msgid "badge_classroom_tutos"
 msgstr ""
 
 #: ../../api_detailed.rst:7
-msgid "package documentation"
+msgid "oggm-edu package documentation"
 msgstr ""
 
 #: ../../api_detailed.rst:11
 msgid ""
-"Here follows a list of the `oggm-edu` classes and their functionality. "
+"Here follows a list of the ``oggm-edu`` classes and their functionality. "
 "The best way to learn is to navigate between this static documentation "
 "and the `rendered notebooks <https://oggm.org/oggm-edu-notebooks>`_ or "
 "the interactive version on MyBinder!"
@@ -583,3 +583,16 @@ msgstr ""
 msgid "GlacierCollection example"
 msgstr ""
 
+#~ msgid "package documentation"
+#~ msgstr ""
+
+#~ msgid ""
+#~ "Here follows a list of the "
+#~ "`oggm-edu` classes and their functionality."
+#~ " The best way to learn is to"
+#~ " navigate between this static documentation"
+#~ " and the `rendered notebooks "
+#~ "<https://oggm.org/oggm-edu-notebooks>`_ or the"
+#~ " interactive version on MyBinder!"
+#~ msgstr ""
+
diff --git a/docs/locale/de/LC_MESSAGES/index.po b/docs/locale/de/LC_MESSAGES/index.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: OGGM-Edu 1.0\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2022-06-28 18:30+0200\n"
+"POT-Creation-Date: 2022-06-28 18:39+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -41,6 +41,10 @@ msgstr ""
 msgid "For instructors and teachers"
 msgstr ""
 
+#: ../../index.rst:163
+msgid "Package documentation"
+msgstr ""
+
 #: ../../<rst_prolog>:1
 msgid "badge_bokeh_en"
 msgstr ""
@@ -258,99 +262,99 @@ msgstr ""
 msgid ":doc:`roadmap`"
 msgstr ""
 
-#: ../../index.rst:166
+#: ../../index.rst:173
 msgid "Get in touch"
 msgstr ""
 
-#: ../../index.rst:168
+#: ../../index.rst:175
 msgid "Interested in OGGM-Edu? We would love to hear from you!"
 msgstr ""
 
-#: ../../index.rst:170
+#: ../../index.rst:177
 msgid "All of this website and notebooks are located `on GitHub`_."
 msgstr ""
 
-#: ../../index.rst:171
+#: ../../index.rst:178
 msgid "Report bugs or share your ideas on the `issue tracker`_."
 msgstr ""
 
-#: ../../index.rst:172
+#: ../../index.rst:179
 msgid "Improve the website by submitting a `pull request`_."
 msgstr ""
 
-#: ../../index.rst:173
+#: ../../index.rst:180
 msgid "Follow us on `Twitter`_."
 msgstr ""
 
-#: ../../index.rst:174
+#: ../../index.rst:181
 msgid "Or you can always send us an `e-mail`_ the good old way."
 msgstr ""
 
-#: ../../index.rst:183
+#: ../../index.rst:190
 msgid "Acknowledgements"
 msgstr ""
 
-#: ../../index.rst:185
+#: ../../index.rst:192
 msgid ""
 "OGGM-Edu is an affiliated project of the larger OGGM consortium "
 "(`oggm.org <https://oggm.org>`_). It is mainly the work of volunteers, "
 "but we also had support from various sources:"
 msgstr ""
 
-#: ../../index.rst:189
+#: ../../index.rst:196
 msgid ""
 "the University of Innsbruck, Förderkreis **1669** – **Wissen** schafft "
 "Gesell **schaft** (2019-2020)."
 msgstr ""
 
-#: ../../index.rst:191
+#: ../../index.rst:198
 msgid "the German BMBF (project FKZ 01LS1602A, 2017-2019)."
 msgstr ""
 
-#: ../../index.rst:192
+#: ../../index.rst:199
 msgid ""
 "`Google Cloud | Data Solutions for Change`_ who provided cloud computing "
 "and hosting credits (2019-2020)."
 msgstr ""
 
-#: ../../index.rst:194
+#: ../../index.rst:201
 msgid ""
 "the University of Innsbruck, department of `Digital Sciences "
 "<https://www.uibk.ac.at/zid/abteilungen/lt/>`_ (Neue Medien Projekte, "
 "2018)."
 msgstr ""
 
-#: ../../index.rst:197
+#: ../../index.rst:204
 msgid ""
 "the OGGM e.V. organisation, who supported the creation of the OGGM-Edu "
 "logo and of the glacier graphics."
 msgstr ""
 
-#: ../../index.rst:224
+#: ../../index.rst:231
 msgid "We rely on awesome open source tools to run OGGM-Edu! Most notably:"
 msgstr ""
 
-#: ../../index.rst:226
+#: ../../index.rst:233
 msgid "`Jupyter <https://jupyter.org>`_"
 msgstr ""
 
-#: ../../index.rst:227
+#: ../../index.rst:234
 msgid "`MyBinder <https://mybinder.org>`_"
 msgstr ""
 
-#: ../../index.rst:228
+#: ../../index.rst:235
 msgid "`HoloViz <http://holoviz.org/>`_"
 msgstr ""
 
-#: ../../index.rst:229
+#: ../../index.rst:236
 msgid "`ReadTheDocs <https://readthedocs.org>`_"
 msgstr ""
 
-#: ../../index.rst:230
+#: ../../index.rst:237
 msgid "and many (many) other packages of the scientific python ecosytem"
 msgstr ""
 
-#: ../../index.rst:232
+#: ../../index.rst:239
 msgid ""
 "Last but not least: thanks to all OGGM-Edu friends and contributors! For "
 "a full list, see our `github repository <https://github.com/OGGM/oggm-"

diff --git a/docs/locale/es/LC_MESSAGES/api_detailed.po b/docs/locale/es/LC_MESSAGES/api_detailed.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: OGGM-Edu 1.0\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2022-06-28 18:30+0200\n"
+"POT-Creation-Date: 2022-06-28 18:39+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -46,12 +46,12 @@ msgid "badge_classroom_tutos"
 msgstr ""
 
 #: ../../api_detailed.rst:7
-msgid "package documentation"
+msgid "oggm-edu package documentation"
 msgstr ""
 
 #: ../../api_detailed.rst:11
 msgid ""
-"Here follows a list of the `oggm-edu` classes and their functionality. "
+"Here follows a list of the ``oggm-edu`` classes and their functionality. "
 "The best way to learn is to navigate between this static documentation "
 "and the `rendered notebooks <https://oggm.org/oggm-edu-notebooks>`_ or "
 "the interactive version on MyBinder!"
@@ -583,3 +583,16 @@ msgstr ""
 msgid "GlacierCollection example"
 msgstr ""
 
+#~ msgid "package documentation"
+#~ msgstr ""
+
+#~ msgid ""
+#~ "Here follows a list of the "
+#~ "`oggm-edu` classes and their functionality."
+#~ " The best way to learn is to"
+#~ " navigate between this static documentation"
+#~ " and the `rendered notebooks "
+#~ "<https://oggm.org/oggm-edu-notebooks>`_ or the"
+#~ " interactive version on MyBinder!"
+#~ msgstr ""
+
diff --git a/docs/locale/es/LC_MESSAGES/index.po b/docs/locale/es/LC_MESSAGES/index.po
@@ -8,7 +8,7 @@ msgid ""
 msgstr ""
 "Project-Id-Version: OGGM-Edu 1.0\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2022-06-28 18:30+0200\n"
+"POT-Creation-Date: 2022-06-28 18:39+0200\n"
 "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
 "Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
 "Language-Team: LANGUAGE <LL@li.org>\n"
@@ -41,6 +41,10 @@ msgstr ""
 msgid "For instructors and teachers"
 msgstr ""
 
+#: ../../index.rst:163
+msgid "Package documentation"
+msgstr ""
+
 #: ../../<rst_prolog>:1
 msgid "badge_bokeh_en"
 msgstr ""
@@ -258,99 +262,99 @@ msgstr ""
 msgid ":doc:`roadmap`"
 msgstr ""
 
-#: ../../index.rst:166
+#: ../../index.rst:173
 msgid "Get in touch"
 msgstr ""
 
-#: ../../index.rst:168
+#: ../../index.rst:175
 msgid "Interested in OGGM-Edu? We would love to hear from you!"
 msgstr ""
 
-#: ../../index.rst:170
+#: ../../index.rst:177
 msgid "All of this website and notebooks are located `on GitHub`_."
 msgstr ""
 
-#: ../../index.rst:171
+#: ../../index.rst:178
 msgid "Report bugs or share your ideas on the `issue tracker`_."
 msgstr ""
 
-#: ../../index.rst:172
+#: ../../index.rst:179
 msgid "Improve the website by submitting a `pull request`_."
 msgstr ""
 
-#: ../../index.rst:173
+#: ../../index.rst:180
 msgid "Follow us on `Twitter`_."
 msgstr ""
 
-#: ../../index.rst:174
+#: ../../index.rst:181
 msgid "Or you can always send us an `e-mail`_ the good old way."
 msgstr ""
 
-#: ../../index.rst:183
+#: ../../index.rst:190
 msgid "Acknowledgements"
 msgstr ""
 
-#: ../../index.rst:185
+#: ../../index.rst:192
 msgid ""
 "OGGM-Edu is an affiliated project of the larger OGGM consortium "
 "(`oggm.org <https://oggm.org>`_). It is mainly the work of volunteers, "
 "but we also had support from various sources:"
 msgstr ""
 
-#: ../../index.rst:189
+#: ../../index.rst:196
 msgid ""
 "the University of Innsbruck, Förderkreis **1669** – **Wissen** schafft "
 "Gesell **schaft** (2019-2020)."
 msgstr ""
 
-#: ../../index.rst:191
+#: ../../index.rst:198
 msgid "the German BMBF (project FKZ 01LS1602A, 2017-2019)."
 msgstr ""
 
-#: ../../index.rst:192
+#: ../../index.rst:199
 msgid ""
 "`Google Cloud | Data Solutions for Change`_ who provided cloud computing "
 "and hosting credits (2019-2020)."
 msgstr ""
 
-#: ../../index.rst:194
+#: ../../index.rst:201
 msgid ""
 "the University of Innsbruck, department of `Digital Sciences "
 "<https://www.uibk.ac.at/zid/abteilungen/lt/>`_ (Neue Medien Projekte, "
 "2018)."
 msgstr ""
 
-#: ../../index.rst:197
+#: ../../index.rst:204
 msgid ""
 "the OGGM e.V. organisation, who supported the creation of the OGGM-Edu "
 "logo and of the glacier graphics."
 msgstr ""
 
-#: ../../index.rst:224
+#: ../../index.rst:231
 msgid "We rely on awesome open source tools to run OGGM-Edu! Most notably:"
 msgstr ""
 
-#: ../../index.rst:226
+#: ../../index.rst:233
 msgid "`Jupyter <https://jupyter.org>`_"
 msgstr ""
 
-#: ../../index.rst:227
+#: ../../index.rst:234
 msgid "`MyBinder <https://mybinder.org>`_"
 msgstr ""
 
-#: ../../index.rst:228
+#: ../../index.rst:235
 msgid "`HoloViz <http://holoviz.org/>`_"
 msgstr ""
 
-#: ../../index.rst:229
+#: ../../index.rst:236
 msgid "`ReadTheDocs <https://readthedocs.org>`_"
 msgstr ""
 
-#: ../../index.rst:230
+#: ../../index.rst:237
 msgid "and many (many) other packages of the scientific python ecosytem"
 msgstr ""
 
-#: ../../index.rst:232
+#: ../../index.rst:239
 msgid ""
 "Last but not least: thanks to all OGGM-Edu friends and contributors! For "
 "a full list, see our `github repository <https://github.com/OGGM/oggm-"