Fixed dependancies warnings introduced by sphinx_toolbox (#1339)

* Added versioning for sphinx, docutils - introduced by sphinxtoolbox

* Fixed bug with config value for `plot_gallery` in doc makefile

* Update linkcheck command as well

Author: eddiebergman

doc/Makefile

@@ -60,7 +60,7 @@ html:
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
 html-noexamples:
-	$(SPHINXBUILD) -D plot_gallery=0 -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
+	SPHINX_GALLERY_PLOT=False $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html
 	@echo
 	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
 
@@ -167,7 +167,7 @@ changes:
 	@echo "The overview file is in $(BUILDDIR)/changes."
 
 linkcheck:
-	$(SPHINXBUILD) -D plot_gallery=0 -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	SPHINX_GALLERY_PLOT=False $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
 	@echo
 	@echo "Link check complete; look for any errors in the above output " \
 	      "or in $(BUILDDIR)/linkcheck/output.txt."

doc/conf.py

@@ -68,6 +68,22 @@
 if "dev" in autosklearn.__version__:
     binder_branch = "development"
 
+# Getting issues with the `-D plot_gallery=0` for sphinx gallery, this is a workaround
+# We do this by setting an evironment variable we check and modifying the python config
+# object.
+# We have this extra processing as it enters as a raw string and we need a boolean value
+gallery_env_var ="SPHINX_GALLERY_PLOT"
+
+sphinx_plot_gallery_flag = True
+if gallery_env_var in os.environ:
+    value = os.environ[gallery_env_var]
+    if value in ["False", "false", "0"]:
+        sphinx_plot_gallery_flag = False
+    elif value in ["True", "true", "1"]:
+        sphinx_plot_gallery_flag = True
+    else:
+        raise ValueError(f'Env variable {gallery_env_var} must be set to "false" or "true"')
+
 sphinx_gallery_conf = {
     # path to the examples
     'examples_dirs': '../examples',
@@ -78,6 +94,7 @@
     #'reference_url': {
     #    'autosklearn': None
     #},
+    'plot_gallery': sphinx_plot_gallery_flag,
     'backreferences_dir': None,
     'filename_pattern': 'example.*.py$',
     'ignore_pattern': r'custom_metrics\.py|__init__\.py|example_parallel_manual_spawning_python.py',

setup.py

@@ -42,11 +42,12 @@
         "seaborn",
     ],
     "docs": [
-        "sphinx",
-        "sphinx-gallery<=0.10.0",
+        "sphinx<4.3",
+        "sphinx-gallery",
         "sphinx_bootstrap_theme",
         "numpydoc",
         "sphinx_toolbox",
+        "docutils==0.16"
     ],
 }