doc: use sphinx-gallery for short examples

epfl-lts2 · Mar 28, 2019 · 2798f99 · 2798f99
1 parent dbdaaa1
commit 2798f99
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 6 deletions.
diff --git a/.gitignore b/.gitignore
@@ -25,7 +25,8 @@ output/*.html
 output/*/index.html
 
 # Sphinx documentation
-doc/_build
+/doc/_build
+/doc/examples/
 
 # Vim swap files
 .*.swp

diff --git a/doc/conf.py b/doc/conf.py
@@ -2,11 +2,13 @@
 
 import pygsp
 
-extensions = ['sphinx.ext.viewcode',
-              'sphinx.ext.autosummary',
-              'sphinx.ext.mathjax',
-              'sphinx.ext.inheritance_diagram',
-              'sphinxcontrib.bibtex']
+extensions = [
+    'sphinx.ext.viewcode',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.inheritance_diagram',
+    'sphinxcontrib.bibtex',
+]
 
 extensions.append('sphinx.ext.autodoc')
 autodoc_default_flags = ['members', 'undoc-members']
@@ -39,6 +41,17 @@
 from pygsp import graphs, filters, utils, plotting
 """
 
+extensions.append('sphinx_gallery.gen_gallery')
+sphinx_gallery_conf = {
+    'examples_dirs': '../examples',
+    'gallery_dirs': 'examples',
+    'filename_pattern': '/',
+    'reference_url': {
+        'pygsp': None,
+    },
+    'show_memory': True,
+}
+
 exclude_patterns = ['_build']
 source_suffix = '.rst'
 master_doc = 'index'

diff --git a/doc/index.rst b/doc/index.rst
@@ -5,6 +5,7 @@
 
    Home <self>
    tutorials/index
+   examples/index
    reference/index
    contributing
    history

diff --git a/examples/README.txt b/examples/README.txt
@@ -0,0 +1,3 @@
+========
+Examples
+========
diff --git a/setup.py b/setup.py
@@ -61,6 +61,8 @@
             'sphinx',
             'numpydoc',
             'sphinxcontrib-bibtex',
+            'sphinx-gallery',
+            'memory_profiler',
             'sphinx-rtd-theme',
             # Build and upload packages.
             'wheel',