Update documentation backend and reduce warnings in doc creation (#1199)

.gitignore

@@ -73,11 +73,8 @@ instance/
 
 # Sphinx documentation
 docs/_build/
-# automatically generated content
-docs/source/modules/auto_generated/
-docs/source/api_reference/modules/auto_generated/
-
-# automatically sym-linked example notebooks
+docs/source/api_reference/auto_generated/
+docs/estimator_overview_table.md
 docs/source/examples
 
 # PyBuilder

.readthedocs.yml

@@ -18,3 +18,4 @@ python:
 
 sphinx:
   configuration: docs/source/conf.py
+#  fail_on_warning: True

CHANGELOG.rst

@@ -310,8 +310,7 @@ Changed
 
 Fixed
 ~~~~~
-* Fix links in Readthedocs and Binder launch button (#416)
-@mloning
+* Fix links in Readthedocs and Binder launch button (#416) @mloning
 * Fixed small bug in performance metrics (#422) @krumeto
 * Resolved warnings in notebook examples (#418) @alwinw
 * Resolves #325 ModuleNotFoundError for soft dependencies (#410) @alwinw

docs/Makefile

@@ -3,7 +3,7 @@
 # You can set these variables from the command line.
 PREPROCESS    = sphinx-apidoc
 APIDOCTEMPLATEDIR = source/_templates/apidoc
-AUTOGENDIR    = source/modules/auto_generated
+AUTOGENDIR    = source/api_reference/auto_generated
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 SOURCEDIR     = source

docs/requirements.txt

@@ -1,7 +1,10 @@
 jupyter
-m2r2
-nbsphinx
+myst-parser
+nbsphinx==0.8.6
 numpydoc
-sphinx==3.2.*
-sphinx_rtd_theme
+pydata-sphinx-theme
+sphinx==4.1.1
+sphinx-gallery==0.6.0
+sphinx-panels==0.6.0
+sphinx_issues==1.2.0
 tabulate

docs/source/_templates/class.rst

@@ -1,4 +1,4 @@
-:mod:`{{module}}`.{{objname}}
+{{objname}}
 {{ underline }}==============
 
 .. currentmodule:: {{ module }}

docs/source/_templates/class_with_call.rst

@@ -1,14 +1,10 @@
-:mod:`{{module}}`.{{objname}}
+{{objname}}
 {{ underline }}===============
 
 .. currentmodule:: {{ module }}
 
 .. autoclass:: {{ objname }}
-
-   {% block methods %}
-   .. automethod:: __init__
-   .. automethod:: __call__
-   {% endblock %}
+   :special-members: __call__
 
 .. include:: {{module}}.{{objname}}.examples
 

docs/source/_templates/function.rst

@@ -1,4 +1,4 @@
-:mod:`{{module}}`.{{objname}}
+{{objname}}
 {{ underline }}====================
 
 .. currentmodule:: {{ module }}