Move tutorials under docs

- suggested by JOSS editor - uncomment notebook tests to see if this passes
simpeg · Mar 30, 2024 · 1b74a68 · 1b74a68
1 parent c49a393
commit 1b74a68
Show file tree

Hide file tree

Showing 9 changed files with 5 additions and 5 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -56,9 +56,9 @@ jobs:
         jupyter nbconvert --to notebook --execute docs/examples/make_cas04_single_station_h5.ipynb
         jupyter nbconvert --to notebook --execute docs/examples/operate_aurora.ipynb
         jupyter nbconvert --to notebook --execute tests/test_run_on_commit.ipynb
-        jupyter nbconvert --to notebook --execute tutorials/pole_zero_fitting/lemi_pole_zero_fitting_example.ipynb
-        jupyter nbconvert --to notebook --execute tutorials/processing_configuration.ipynb
-        jupyter nbconvert --to notebook --execute tutorials/synthetic_data_processing.ipynb
+        jupyter nbconvert --to notebook --execute docs/tutorials/pole_zero_fitting/lemi_pole_zero_fitting_example.ipynb
+        jupyter nbconvert --to notebook --execute docs/tutorials/processing_configuration.ipynb
+        jupyter nbconvert --to notebook --execute docs/tutorials/synthetic_data_processing.ipynb
         # Replace "notebook.ipynb" with your notebook's filename
 
 #    - name: Commit changes (if any)

diff --git a/docs/conf.py b/docs/conf.py
@@ -101,7 +101,7 @@
 sphinx_gallery_conf = {
     # path to your examples scripts
     "examples_dirs": [
-        "../tutorials",
+        "tutorials",
     ],
     "gallery_dirs": [
         "examples",

diff --git a/docs/index.rst b/docs/index.rst
@@ -15,7 +15,7 @@
    :maxdepth: 2
    :caption: Examples
 
-   notebooks/operate_aurora.ipynb
+   examples/operate_aurora.ipynb
 
 .. toctree::
    :maxdepth: 2

diff --git a/tutorials/README.txt → docs/tutorials/README.txt b/tutorials/README.txt → docs/tutorials/README.txt
diff --git a/tutorials/pkd_units_check.ipynb → docs/tutorials/pkd_units_check.ipynb b/tutorials/pkd_units_check.ipynb → docs/tutorials/pkd_units_check.ipynb
diff --git a/...ing/Lemi-039_N131BxByBz/Lemi-039_N131.cal → ...ing/Lemi-039_N131BxByBz/Lemi-039_N131.cal b/...ing/Lemi-039_N131BxByBz/Lemi-039_N131.cal → ...ing/Lemi-039_N131BxByBz/Lemi-039_N131.cal
diff --git a/...ting/lemi_pole_zero_fitting_example.ipynb → ...ting/lemi_pole_zero_fitting_example.ipynb b/...ting/lemi_pole_zero_fitting_example.ipynb → ...ting/lemi_pole_zero_fitting_example.ipynb
diff --git a/tutorials/processing_configuration.ipynb → .../tutorials/processing_configuration.ipynb b/tutorials/processing_configuration.ipynb → .../tutorials/processing_configuration.ipynb
diff --git a/tutorials/synthetic_data_processing.ipynb → ...tutorials/synthetic_data_processing.ipynb b/tutorials/synthetic_data_processing.ipynb → ...tutorials/synthetic_data_processing.ipynb