MNT rename build directories with an underscore

Author: TomDLT

.gitignore

@@ -9,6 +9,4 @@ __pycache__
 
 # Documentation build
 doc/_build/
-doc/_statis/
-doc/_template/
-doc/auto_examples/
+doc/_auto_examples/

doc/Makefile

@@ -20,8 +20,8 @@ help:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 clean:
-	rm -rf $(BUILDDIR)/*
-	rm -rf auto_examples/
+	rm -rf $(BUILDDIR)/
+	rm -rf _auto_examples/
 
 html-noplot:
 	$(SPHINXBUILD) -D plot_gallery=0 -b html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/conf.py

@@ -46,7 +46,7 @@
     # path to your examples scripts
     'examples_dirs': '../tutorials',
     # path where to save gallery generated examples
-    'gallery_dirs': 'auto_examples',
+    'gallery_dirs': '_auto_examples',
     # which files to execute? only those with "plot_"
     'filename_pattern': 'plot_',
     # 'ignore_pattern': 'download',
@@ -57,7 +57,7 @@
 }
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ['templates']
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
@@ -124,7 +124,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

doc/create_notebooks.py

@@ -3,7 +3,7 @@
     import os
     import shutil
 
-    archive_name = "auto_examples/auto_examples_jupyter.zip"
+    archive_name = "_auto_examples/auto_examples_jupyter.zip"
     if not os.path.exists(archive_name):
         raise RuntimeError(
             f"{archive_name} does not exist, please run `make html` first.")