BUILD: add pyyaml

jklymak · jklymak · commit bcb08ea573af · 2023-01-08T20:24:07.000-08:00
diff --git a/doc/Makefile b/doc/Makefile
@@ -38,7 +38,7 @@ html-noplot:
 # to quickly build parts of the docs, but the resulting build will not
 # have all the crosslinks etc.
 html-skip-subdirs:
-	$(SPHINXBUILD) -D skip_subdirs=1 -b html $(SOURCEDIR) $(BUILDDIR)/html $(SPHINXOPTS) $(O)
+	$(SPHINXBUILD) -D skip_sub_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).
diff --git a/doc/conf.py b/doc/conf.py
@@ -61,14 +61,14 @@ def _parse_skip_subdirs_file():
             yaml.dump(yamldict, fout)
         print('Skipping subdirectories, but .mpl_skip_subdirs.yaml',
               'not found so creating a default one. Edit this file',
-              'to customize which diretories are included in build.')
+              'to customize which directories are included in build.')
 
         return default_skip_subdirs
 
 
 skip_subdirs = []
 # triggered via make html-skip-subdirs
-if 'skip_subdirs=1' in sys.argv:
+if 'skip_sub_dirs=1' in sys.argv:
     skip_subdirs = _parse_skip_subdirs_file()
 
 # Parse year using SOURCE_DATE_EPOCH, falling back to current time.
@@ -757,6 +757,6 @@ def setup(app):
         bld_type = 'dev'
     else:
         bld_type = 'rel'
-    app.add_config_value('skip_subdirs', 0, '')
+    app.add_config_value('skip_sub_dirs', 0, '')
     app.add_config_value('releaselevel', bld_type, 'env')
     app.connect('html-page-context', add_html_cache_busting, priority=1000)
diff --git a/doc/make.bat b/doc/make.bat
@@ -53,7 +53,7 @@ goto end
 goto end
 
 :html-skip-subdirs
-%SPHINXBUILD% -M html %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -D skip_subdirs=1
+%SPHINXBUILD% -M html %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -D skip_sub_dirs=1
 goto end
 
 
diff --git a/environment.yml b/environment.yml
@@ -33,6 +33,7 @@ dependencies:
   - numpydoc>=0.8
   - packaging
   - pydata-sphinx-theme
+  - pyyaml
   - sphinx>=1.8.1,!=2.0.0
   - sphinx-copybutton
   - sphinx-gallery>=0.10
diff --git a/requirements/doc/doc-requirements.txt b/requirements/doc/doc-requirements.txt
@@ -15,6 +15,7 @@ numpydoc>=1.0
 packaging>=20
 pydata-sphinx-theme>=0.12.0
 mpl-sphinx-theme
+pyyaml
 sphinxcontrib-svg2pdfconverter>=1.1.0
 sphinx-gallery>=0.10
 sphinx-copybutton
