DOC/BUILD add ability for conf to skip whole sections

jklymak · jklymak · commit 53695e938886 · 2023-01-07T21:42:30.000-08:00
diff --git a/doc/conf.py b/doc/conf.py
@@ -34,6 +34,21 @@
 # are we running circle CI?
 CIRCLECI = 'CIRCLECI' in os.environ
 
+# shortcuts: subdirectories to not build.  Should be relative
+# to the doc directory.  Note that you cannot skip "users"
+# but can skip subdirectories...
+#
+# Note if any of the sphinx-galleries are skipped then they
+# will not be built using sphinx-gallery.
+skip_subdirs = []
+if False:
+    skip_subdirs = ['users/prev_whats_new/*',
+                    'gallery/*',
+                    'api/*',
+                    'tutorials/*',
+                    'plot_types/*',
+                    'devel/*']
+
 # Parse year using SOURCE_DATE_EPOCH, falling back to current time.
 # https://reproducible-builds.org/specs/source-date-epoch/
 sourceyear = datetime.utcfromtimestamp(
@@ -80,9 +95,10 @@
 ]
 
 exclude_patterns = [
-    'api/prev_api_changes/api_changes_*/*',
+    'api/prev_api_changes/api_changes_*/*'
 ]
 
+exclude_patterns += skip_subdirs
 
 def _check_dependencies():
     names = {
@@ -157,7 +173,6 @@ def _check_dependencies():
     'xarray': ('https://docs.xarray.dev/en/stable/', None),
 }
 
-
 # Sphinx gallery configuration
 
 def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,
@@ -174,13 +189,20 @@ def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,
         gallery_conf['image_srcset'] = []
     return matplotlib_scraper(block, block_vars, gallery_conf, **kwargs)
 
+example_dirs = []
+if 'gallery/*' not in skip_subdirs:
+    example_dirs += ['../examples']
+if 'tutorials/*' not in skip_subdirs:
+    example_dirs += ['../tutorials']
+if 'plot_types/*' not in skip_subdirs:
+    example_dirs += ['../plot_types']
 
 sphinx_gallery_conf = {
     'backreferences_dir': Path('api') / Path('_as_gen'),
     # Compression is a significant effort that we skip for local and CI builds.
     'compress_images': ('thumbnails', 'images') if is_release_build else (),
     'doc_module': ('matplotlib', 'mpl_toolkits'),
-    'examples_dirs': ['../examples', '../tutorials', '../plot_types'],
+    'examples_dirs': example_dirs,
     'filename_pattern': '^((?!sgskip).)*$',
     'gallery_dirs': ['gallery', 'tutorials', 'plot_types'],
     'image_scrapers': (matplotlib_reduced_latex_scraper, ),
