first version of orignal WDM implementation should be working now

dspelaez · Jul 16, 2024 · 85a68da · 85a68da
1 parent 1de038c
commit 85a68da
Show file tree

Hide file tree

Showing 6 changed files with 9 additions and 89 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -24,7 +24,8 @@
 extensions = [
     'sphinx.ext.autodoc',
     'sphinx.ext.viewcode',
-    'sphinx.ext.napoleon'
+    'sphinx.ext.napoleon',
+    'sphinx_gallery.gen_gallery'
 ]
 
 templates_path = ['_templates']
@@ -34,6 +35,11 @@
 napoleon_google_docstring = True
 napoleon_include_init_with_doc = True
 
+# gallery configuration
+sphinx_gallery_conf = {
+    'examples_dirs': 'gallery',    # path to your example scripts
+    'gallery_dirs': 'auto_gallery' # path to where to save gallery generated output
+}
 
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/docs/ewdm.rst b/docs/ewdm.rst
@@ -4,14 +4,6 @@ API Reference
 Submodules
 ----------
 
-ewdm.fourier module
--------------------
-
-.. automodule:: ewdm.fourier
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 ewdm.helpers module
 -------------------
 

diff --git a/docs/examples.rst b/docs/examples.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -72,7 +72,7 @@ Directional Method.
 
    getting_started
    maths
-   examples
+   gallery
 
 
 API Documentation

diff --git a/notebooks/example.py b/notebooks/example.py
diff --git a/pyproject.toml b/pyproject.toml
@@ -47,5 +47,6 @@ extra = ["zarr"]
 docs = [
     "sphinx",
     "sphinx-rtd-theme",
+    "sphinx-gallery",
     "autodoc"
 ]
-Original file line number
+Diff line change
@@ Expand Up / @@ -72,7 +72,7 @@ Directional Method. @@
        getting_started
        maths
-       examples
+       gallery
     API Documentation
@@ Expand Down @@