docs: enable nbgallery for user guide

mdtanker · Dec 9, 2023 · 2bcc0aa · 2bcc0aa
1 parent e134b4a
commit 2bcc0aa
Show file tree

Hide file tree

Showing 11 changed files with 69 additions and 13 deletions.
diff --git a/docs/gallery/index.md b/docs/gallery/index.md
@@ -1,5 +1,11 @@
-#
+# 📚 Gallery
 
 ```{warning}
 Gallery examples still to come ...
 ```
+
+<!-- ```{nbgallery}
+---
+---
+Add notebook names here
+``` -->
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,5 @@
 # Invert4geom
+
 3D geometric gravity inversions
 
 ```{include} ../README.md
@@ -22,9 +23,11 @@
 :hidden:
 overview
 install
+gallery/index.md
+user_guide/index.md
 ```
 
-```{toctree}
+<!-- ```{toctree}
 :maxdepth: 1
 :hidden:
 :caption: 🚶 User guide
@@ -36,14 +39,14 @@ user_guide/including_starting_model
 user_guide/adhering_to_constraints
 user_guide/combining_it_all
 user_guide/estimating_regional_field
-```
+``` -->
 
-```{toctree}
+<!-- ```{toctree}
 :maxdepth: 1
 :hidden:
 :caption: 📚 Gallery
 gallery/index.md
-```
+``` -->
 
 ```{toctree}
 :maxdepth: 2

diff --git a/docs/user_guide/adhering_to_constraints.ipynb b/docs/user_guide/adhering_to_constraints.ipynb
@@ -714,7 +714,11 @@
   {
    "cell_type": "code",
    "execution_count": 9,
-   "metadata": {},
+   "metadata": {
+    "tags": [
+     "nbsphinx-thumbnail"
+    ]
+   },
    "outputs": [
     {
      "data": {

diff --git a/docs/user_guide/combining_it_all.ipynb b/docs/user_guide/combining_it_all.ipynb
@@ -1728,7 +1728,11 @@
   {
    "cell_type": "code",
    "execution_count": 65,
-   "metadata": {},
+   "metadata": {
+    "tags": [
+     "nbsphinx-thumbnail"
+    ]
+   },
    "outputs": [
     {
      "name": "stdout",

diff --git a/docs/user_guide/damping_cross_validation.ipynb b/docs/user_guide/damping_cross_validation.ipynb
@@ -803,7 +803,11 @@
   {
    "cell_type": "code",
    "execution_count": 38,
-   "metadata": {},
+   "metadata": {
+    "tags": [
+     "nbsphinx-thumbnail"
+    ]
+   },
    "outputs": [
     {
      "data": {

diff --git a/docs/user_guide/density_cross_validation.ipynb b/docs/user_guide/density_cross_validation.ipynb
@@ -566,7 +566,11 @@
   {
    "cell_type": "code",
    "execution_count": 14,
-   "metadata": {},
+   "metadata": {
+    "tags": [
+     "nbsphinx-thumbnail"
+    ]
+   },
    "outputs": [
     {
      "data": {

diff --git a/docs/user_guide/estimating_regional_field.ipynb b/docs/user_guide/estimating_regional_field.ipynb
@@ -104,7 +104,11 @@
   {
    "cell_type": "code",
    "execution_count": 3,
-   "metadata": {},
+   "metadata": {
+    "tags": [
+     "nbsphinx-thumbnail"
+    ]
+   },
    "outputs": [
     {
      "data": {

diff --git a/docs/user_guide/including_starting_model.ipynb b/docs/user_guide/including_starting_model.ipynb
@@ -418,7 +418,11 @@
   {
    "cell_type": "code",
    "execution_count": 8,
-   "metadata": {},
+   "metadata": {
+    "tags": [
+     "nbsphinx-thumbnail"
+    ]
+   },
    "outputs": [
     {
      "data": {

diff --git a/docs/user_guide/index.md b/docs/user_guide/index.md
@@ -0,0 +1,15 @@
+# 🚶 User guide
+
+```{nbgallery}
+---
+name: user guide
+---
+simple_inversion
+damping_cross_validation
+density_cross_validation
+reference_level_cross_validation
+including_starting_model
+adhering_to_constraints
+combining_it_all
+estimating_regional_field
+```
diff --git a/docs/user_guide/reference_level_cross_validation.ipynb b/docs/user_guide/reference_level_cross_validation.ipynb
@@ -564,7 +564,11 @@
   {
    "cell_type": "code",
    "execution_count": 9,
-   "metadata": {},
+   "metadata": {
+    "tags": [
+     "nbsphinx-thumbnail"
+    ]
+   },
    "outputs": [
     {
      "data": {

diff --git a/docs/user_guide/simple_inversion.ipynb b/docs/user_guide/simple_inversion.ipynb
@@ -1307,7 +1307,11 @@
   {
    "cell_type": "code",
    "execution_count": 30,
-   "metadata": {},
+   "metadata": {
+    "tags": [
+     "nbsphinx-thumbnail"
+    ]
+   },
    "outputs": [
     {
      "name": "stdout",