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

…) (#1205) Update in documentation back-end, all docstrings fixed for pydocstype. #### Reference issues/PR Fixes #1181 Fixes #1230 Partly addresses #1152 #### What does this implement/fix? Explain your changes. * replaces `readthedocs-theme` with `pydata-sphinx-theme` * restructures content in line with new theme * adds new getting started page * fixes autodoc display of summaries of classes and functions * fixes sphinx build and warnings * fixes docstrings and numpydoc warnings * adds tutorial notebook thumbnail gallery * adds links to Twitter, Discord and GitHub * fixes wrong auto-generation directory in sphinx build * updates version of sphinx and related packages * integrates `myst-parser` replacing `m2r2` * update `.gitignore` to exclude auto-generated documentation files * adds glossary * removes full module path from page titles in API reference * removes module names from table of content in API reference using more readable names (e.g. instead of "sktime.forecasting" we now simply use "Forecasting") * adds page for adding estimators using extension templates * adds page for enhancement proposals #### Does your contribution introduce a new dependency? If yes, which one? For generating docs only: * `pydata-sphinx-theme` (replaces `readthedocs` theme) * `myst-parser` (replaces `m2r2`) * `sphinx-gallery`
sktime · Aug 15, 2021 · d981c37 · d981c37
1 parent 53a3a62
commit d981c37
Show file tree

Hide file tree

Showing 158 changed files with 2,153 additions and 1,286 deletions.
diff --git a/.gitignore b/.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

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -18,3 +18,4 @@ python:
 
 sphinx:
   configuration: docs/source/conf.py
+#  fail_on_warning: True
diff --git a/CHANGELOG.rst b/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

diff --git a/docs/Makefile b/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

diff --git a/docs/estimator_overview_table.md b/docs/estimator_overview_table.md
diff --git a/docs/requirements.txt b/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
diff --git a/docs/source/_static/fields.css → docs/source/_static/css/fields.css b/docs/source/_static/fields.css → docs/source/_static/css/fields.css
diff --git a/docs/source/_templates/apidoc/module.rst_t b/docs/source/_templates/apidoc/module.rst_t
diff --git a/docs/source/_templates/apidoc/package.rst_t b/docs/source/_templates/apidoc/package.rst_t
diff --git a/docs/source/_templates/apidoc/toc.rst_t b/docs/source/_templates/apidoc/toc.rst_t
diff --git a/docs/source/_templates/class.rst b/docs/source/_templates/class.rst
@@ -1,4 +1,4 @@
-:mod:`{{module}}`.{{objname}}
+{{objname}}
 {{ underline }}==============
 
 .. currentmodule:: {{ module }}

diff --git a/docs/source/_templates/class_with_call.rst b/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
 

diff --git a/docs/source/_templates/class_without_init.rst b/docs/source/_templates/class_without_init.rst
diff --git a/docs/source/_templates/function.rst b/docs/source/_templates/function.rst
@@ -1,4 +1,4 @@
-:mod:`{{module}}`.{{objname}}
+{{objname}}
 {{ underline }}====================
 
 .. currentmodule:: {{ module }}

diff --git a/docs/source/_templates/module.rst b/docs/source/_templates/module.rst