doc: mv ipynb tutorials

fluiddyn · Feb 16, 2024 · ab667ed · ab667ed
1 parent 6c390aa
commit ab667ed
Show file tree

Hide file tree

Showing 10 changed files with 13 additions and 15 deletions.
diff --git a/.hgignore b/.hgignore
@@ -56,11 +56,9 @@ fluidimage/works/piv/*.h5
 fluidimage/**.dot
 
 doc/generated/*
-doc/ipynb/*.rst
-doc/ipynb/*.h5
-doc/ipynb/.ipynb_checkpoints/*
-doc/ipynb/*.nbconvert.ipynb
-doc/ipynb/**.png
+doc/tutorials/*.rst
+doc/tutorials/*.h5
+doc/tutorials/**.png
 doc/examples/oar_launcher*
 doc/examples/topo.dot
 **/.ipynb_checkpoints/*

diff --git a/doc/conf.py b/doc/conf.py
@@ -48,11 +48,11 @@
     "sphinx_copybutton",
 ]
 
-# Execute ipynb files into with a cache ...
+# Execute notebooks into with a cache ...
 nb_execution_mode = "cache"
 nb_execution_cache_path = "./_jupyter_cache"
 os.makedirs(nb_execution_cache_path, exist_ok=True)
-# ... except these ipynb files
+# ... except these files
 nb_execution_excludepatterns = ["ipynbslides/*"]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -62,7 +62,7 @@
 source_suffix = {
     ".rst": "restructuredtext",
     ".ipynb": "myst-nb",
-    ".myst": "myst-nb",
+    ".myst.md": "myst-nb",
 }
 
 # The encoding of source files.

diff --git a/doc/tutorial.md b/doc/tutorial.md
@@ -6,7 +6,7 @@ Here is a tutorial on a very simple PIV computation:
 ---
 maxdepth: 2
 ---
-ipynb/tuto_piv
+tutorials/tuto_piv
 ```
 
 There are also tutorials on calibration and recontruction:
@@ -15,10 +15,10 @@ There are also tutorials on calibration and recontruction:
 ---
 maxdepth: 2
 ---
-ipynb/tuto_calibration2dsimple
-ipynb/tuto_direct_calibration
-ipynb/tuto_stereo_reconstruction
-ipynb/tuto_tsai_calibration
-ipynb/tuto_opencv_calibration
-ipynb/tuto_opencv_tomo_reconstruct
+tutorials/tuto_calibration2dsimple
+tutorials/tuto_direct_calibration
+tutorials/tuto_stereo_reconstruction
+tutorials/tuto_tsai_calibration
+tutorials/tuto_opencv_calibration
+tutorials/tuto_opencv_tomo_reconstruct
 ```
diff --git a/doc/ipynb/tuto_calibration2dsimple.md → doc/tutorials/tuto_calibration2dsimple.md b/doc/ipynb/tuto_calibration2dsimple.md → doc/tutorials/tuto_calibration2dsimple.md
diff --git a/doc/ipynb/tuto_direct_calibration.md → doc/tutorials/tuto_direct_calibration.md b/doc/ipynb/tuto_direct_calibration.md → doc/tutorials/tuto_direct_calibration.md
diff --git a/doc/ipynb/tuto_opencv_calibration.md → doc/tutorials/tuto_opencv_calibration.md b/doc/ipynb/tuto_opencv_calibration.md → doc/tutorials/tuto_opencv_calibration.md
diff --git a/doc/ipynb/tuto_opencv_tomo_reconstruct.md → ...tutorials/tuto_opencv_tomo_reconstruct.md b/doc/ipynb/tuto_opencv_tomo_reconstruct.md → ...tutorials/tuto_opencv_tomo_reconstruct.md
diff --git a/doc/ipynb/tuto_piv.md → doc/tutorials/tuto_piv.md b/doc/ipynb/tuto_piv.md → doc/tutorials/tuto_piv.md
diff --git a/doc/ipynb/tuto_stereo_reconstruction.md → doc/tutorials/tuto_stereo_reconstruction.md b/doc/ipynb/tuto_stereo_reconstruction.md → doc/tutorials/tuto_stereo_reconstruction.md
diff --git a/doc/ipynb/tuto_tsai_calibration.md → doc/tutorials/tuto_tsai_calibration.md b/doc/ipynb/tuto_tsai_calibration.md → doc/tutorials/tuto_tsai_calibration.md