Skip to content

Commit bcb08ea

Browse files
jklymakjklymak
committed
BUILD: add pyyaml
1 parent c6e92e9 commit bcb08ea

5 files changed

Lines changed: 7 additions & 5 deletions

File tree

‎doc/Makefile‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ html-noplot:
3838
# to quickly build parts of the docs, but the resulting build will not
3939
# have all the crosslinks etc.
4040
html-skip-subdirs:
41-
$(SPHINXBUILD) -D skip_subdirs=1 -b html $(SOURCEDIR) $(BUILDDIR)/html $(SPHINXOPTS) $(O)
41+
$(SPHINXBUILD) -D skip_sub_dirs=1 -b html $(SOURCEDIR) $(BUILDDIR)/html $(SPHINXOPTS) $(O)
4242

4343
# Catch-all target: route all unknown targets to Sphinx using the new
4444
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).

‎doc/conf.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,14 +61,14 @@ def _parse_skip_subdirs_file():
6161
yaml.dump(yamldict, fout)
6262
print('Skipping subdirectories, but .mpl_skip_subdirs.yaml',
6363
'not found so creating a default one. Edit this file',
64-
'to customize which diretories are included in build.')
64+
'to customize which directories are included in build.')
6565

6666
return default_skip_subdirs
6767

6868

6969
skip_subdirs = []
7070
# triggered via make html-skip-subdirs
71-
if 'skip_subdirs=1' in sys.argv:
71+
if 'skip_sub_dirs=1' in sys.argv:
7272
skip_subdirs = _parse_skip_subdirs_file()
7373

7474
# Parse year using SOURCE_DATE_EPOCH, falling back to current time.
@@ -757,6 +757,6 @@ def setup(app):
757757
bld_type = 'dev'
758758
else:
759759
bld_type = 'rel'
760-
app.add_config_value('skip_subdirs', 0, '')
760+
app.add_config_value('skip_sub_dirs', 0, '')
761761
app.add_config_value('releaselevel', bld_type, 'env')
762762
app.connect('html-page-context', add_html_cache_busting, priority=1000)

‎doc/make.bat‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ goto end
5353
goto end
5454

5555
:html-skip-subdirs
56-
%SPHINXBUILD% -M html %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -D skip_subdirs=1
56+
%SPHINXBUILD% -M html %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -D skip_sub_dirs=1
5757
goto end
5858

5959

‎environment.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ dependencies:
3333
- numpydoc>=0.8
3434
- packaging
3535
- pydata-sphinx-theme
36+
- pyyaml
3637
- sphinx>=1.8.1,!=2.0.0
3738
- sphinx-copybutton
3839
- sphinx-gallery>=0.10

‎requirements/doc/doc-requirements.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ numpydoc>=1.0
1515
packaging>=20
1616
pydata-sphinx-theme>=0.12.0
1717
mpl-sphinx-theme
18+
pyyaml
1819
sphinxcontrib-svg2pdfconverter>=1.1.0
1920
sphinx-gallery>=0.10
2021
sphinx-copybutton

0 commit comments

Comments
 (0)