DOC: make users/explain a sphinx gallery [ci doc]

jklymak · Mar 17, 2023 · Feb 24, 2023 · Mar 4, 2023 · Mar 4, 2023 · Mar 4, 2023
commit 49e6b9e2d7e1231754404020ebea78f901f03a31
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -97,9 +97,12 @@ commands:
       - run:
           name: Install Python dependencies
           command: |
+            # remove when sphinx-gallery releases #1071:
             python -m pip install --user \
                 numpy<< parameters.numpy_version >> codecov coverage \
                 -r requirements/doc/doc-requirements.txt
+            python -m pip install --no-deps --user \
+                git+https://github.com/sphinx-gallery/sphinx-gallery.git
             python -m pip install --no-deps --user \
                 git+https://github.com/matplotlib/mpl-sphinx-theme.git
 

diff --git a/doc/Makefile b/doc/Makefile
@@ -22,6 +22,7 @@ clean:
 	rm -rf "$(SOURCEDIR)/gallery"
 	rm -rf "$(SOURCEDIR)/plot_types"
 	rm -rf "$(SOURCEDIR)/tutorials"
+	rm -rf "$(SOURCEDIR)/users/explain"
 	rm -rf "$(SOURCEDIR)/savefig"
 	rm -rf "$(SOURCEDIR)/sphinxext/__pycache__"
 	rm -f $(SOURCEDIR)/_static/constrained_layout*.png

diff --git a/doc/conf.py b/doc/conf.py
@@ -213,11 +213,14 @@ def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,
         gallery_conf['image_srcset'] = []
     return matplotlib_scraper(block, block_vars, gallery_conf, **kwargs)
 
-gallery_dirs = [f'{ed}' for ed in ['gallery', 'tutorials', 'plot_types']
+gallery_dirs = [f'{ed}' for ed in
+                ['gallery', 'tutorials', 'plot_types', 'users/explain']
                 if f'{ed}/*' not in skip_subdirs]
 
-example_dirs = [f'../galleries/{gd}'.replace('gallery', 'examples')
-                for gd in gallery_dirs]
+example_dirs = []
+for gd in gallery_dirs:
+    gd = gd.replace('gallery', 'examples').replace('users/explain', 'users_explain')
+    example_dirs += [f'../galleries/{gd}']
 
 sphinx_gallery_conf = {
     'backreferences_dir': Path('api') / Path('_as_gen'),
@@ -244,6 +247,7 @@ def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,
     'thumbnail_size': (320, 224),
     'within_subsection_order': gallery_order.subsectionorder,
     'capture_repr': (),
+    'copyfile_regex': r'.*\.rst',
 }
 
 if 'plot_gallery=0' in sys.argv:

diff --git a/doc/users/explain/api_interfaces.rst → galleries/users_explain/api_interfaces.rst b/doc/users/explain/api_interfaces.rst → galleries/users_explain/api_interfaces.rst
diff --git a/doc/users/explain/backends.rst → galleries/users_explain/backends.rst b/doc/users/explain/backends.rst → galleries/users_explain/backends.rst
diff --git a/doc/users/explain/event_handling.rst → galleries/users_explain/event_handling.rst b/doc/users/explain/event_handling.rst → galleries/users_explain/event_handling.rst
diff --git a/doc/users/explain/figures.rst → galleries/users_explain/figures.rst b/doc/users/explain/figures.rst → galleries/users_explain/figures.rst
diff --git a/doc/users/explain/fonts.rst → galleries/users_explain/fonts.rst b/doc/users/explain/fonts.rst → galleries/users_explain/fonts.rst
diff --git a/doc/users/explain/index.rst → galleries/users_explain/index.rst b/doc/users/explain/index.rst → galleries/users_explain/index.rst
diff --git a/doc/users/explain/interactive.rst → galleries/users_explain/interactive.rst b/doc/users/explain/interactive.rst → galleries/users_explain/interactive.rst
diff --git a/doc/users/explain/interactive_guide.rst → ...eries/users_explain/interactive_guide.rst b/doc/users/explain/interactive_guide.rst → ...eries/users_explain/interactive_guide.rst
diff --git a/doc/users/explain/performance.rst → galleries/users_explain/performance.rst b/doc/users/explain/performance.rst → galleries/users_explain/performance.rst
diff --git a/...in/writing_a_backend_pyplot_interface.rst → ...in/writing_a_backend_pyplot_interface.rst b/...in/writing_a_backend_pyplot_interface.rst → ...in/writing_a_backend_pyplot_interface.rst