From 30fcf6d176dcca50d85ead369c2e7a447878dfcc Mon Sep 17 00:00:00 2001 From: Jody Klymak Date: Thu, 23 Feb 2023 17:57:38 -0800 Subject: [PATCH] DOC: make users/explain a sphinx gallery [ci doc] --- .circleci/config.yml | 3 +++ doc/Makefile | 1 + doc/conf.py | 10 +++++++--- .../users_explain}/api_interfaces.rst | 0 .../explain => galleries/users_explain}/backends.rst | 0 .../users_explain}/event_handling.rst | 0 .../explain => galleries/users_explain}/figures.rst | 0 .../explain => galleries/users_explain}/fonts.rst | 0 .../explain => galleries/users_explain}/index.rst | 0 .../users_explain}/interactive.rst | 0 .../users_explain}/interactive_guide.rst | 0 .../users_explain}/performance.rst | 0 .../writing_a_backend_pyplot_interface.rst | 0 13 files changed, 11 insertions(+), 3 deletions(-) rename {doc/users/explain => galleries/users_explain}/api_interfaces.rst (100%) rename {doc/users/explain => galleries/users_explain}/backends.rst (100%) rename {doc/users/explain => galleries/users_explain}/event_handling.rst (100%) rename {doc/users/explain => galleries/users_explain}/figures.rst (100%) rename {doc/users/explain => galleries/users_explain}/fonts.rst (100%) rename {doc/users/explain => galleries/users_explain}/index.rst (100%) rename {doc/users/explain => galleries/users_explain}/interactive.rst (100%) rename {doc/users/explain => galleries/users_explain}/interactive_guide.rst (100%) rename {doc/users/explain => galleries/users_explain}/performance.rst (100%) rename {doc/users/explain => galleries/users_explain}/writing_a_backend_pyplot_interface.rst (100%) diff --git a/.circleci/config.yml b/.circleci/config.yml index d79f244e052c..d86497f73103 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -97,6 +97,9 @@ commands: - run: name: Install Python dependencies command: | + # remove when sphinx-gallery releases #1071: + 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 python -m pip install --user \ diff --git a/doc/Makefile b/doc/Makefile index c2534ed043e8..53b7c02b68fa 100644 --- 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 index 53e8db7e2158..e139d579c33c 100644 --- 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 b/galleries/users_explain/api_interfaces.rst similarity index 100% rename from doc/users/explain/api_interfaces.rst rename to galleries/users_explain/api_interfaces.rst diff --git a/doc/users/explain/backends.rst b/galleries/users_explain/backends.rst similarity index 100% rename from doc/users/explain/backends.rst rename to galleries/users_explain/backends.rst diff --git a/doc/users/explain/event_handling.rst b/galleries/users_explain/event_handling.rst similarity index 100% rename from doc/users/explain/event_handling.rst rename to galleries/users_explain/event_handling.rst diff --git a/doc/users/explain/figures.rst b/galleries/users_explain/figures.rst similarity index 100% rename from doc/users/explain/figures.rst rename to galleries/users_explain/figures.rst diff --git a/doc/users/explain/fonts.rst b/galleries/users_explain/fonts.rst similarity index 100% rename from doc/users/explain/fonts.rst rename to galleries/users_explain/fonts.rst diff --git a/doc/users/explain/index.rst b/galleries/users_explain/index.rst similarity index 100% rename from doc/users/explain/index.rst rename to galleries/users_explain/index.rst diff --git a/doc/users/explain/interactive.rst b/galleries/users_explain/interactive.rst similarity index 100% rename from doc/users/explain/interactive.rst rename to galleries/users_explain/interactive.rst diff --git a/doc/users/explain/interactive_guide.rst b/galleries/users_explain/interactive_guide.rst similarity index 100% rename from doc/users/explain/interactive_guide.rst rename to galleries/users_explain/interactive_guide.rst diff --git a/doc/users/explain/performance.rst b/galleries/users_explain/performance.rst similarity index 100% rename from doc/users/explain/performance.rst rename to galleries/users_explain/performance.rst diff --git a/doc/users/explain/writing_a_backend_pyplot_interface.rst b/galleries/users_explain/writing_a_backend_pyplot_interface.rst similarity index 100% rename from doc/users/explain/writing_a_backend_pyplot_interface.rst rename to galleries/users_explain/writing_a_backend_pyplot_interface.rst pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy