DOC: add option to Makefile

jklymak · jklymak · commit 68e3df143f09 · 2023-01-08T08:58:19.000-08:00
diff --git a/doc/Makefile b/doc/Makefile
@@ -33,6 +33,13 @@ html-noplot:
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
+# This will skip the directories listed in the skip_subdirs variable
+# in conf.py.  Edit this by hand if you want to change what sections
+# of the docs get built.  Can be much faster.  However, reset conf.py
+# to original values before pushig to github.
+html-skip-dirs:
+	$(SPHINXBUILD) -D skip_dirs=1 -b html $(SOURCEDIR) $(BUILDDIR)/html $(SPHINXOPTS) $(O)
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
diff --git a/doc/conf.py b/doc/conf.py
@@ -41,13 +41,15 @@
 # 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/*']
+if 'skip_dirs=1' in sys.argv:
+    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/
@@ -735,5 +737,6 @@ def setup(app):
         bld_type = 'dev'
     else:
         bld_type = 'rel'
+    app.add_config_value('skip_dirs', 0, '')
     app.add_config_value('releaselevel', bld_type, 'env')
     app.connect('html-page-context', add_html_cache_busting, priority=1000)
