Type Hints for Trainer (#912)

* typehints for trainer fix type links in docs fix types in docs type hints for trainer methods fix fit docs switch to comments readability added sphinx typehints extension wip remove typehints from docstring more type annotations fix spaces * Update trainer.py Co-authored-by: William Falcon <waf2107@columbia.edu>
Lightning-AI · Feb 23, 2020 · da2f11a · da2f11a
1 parent e05586c
commit da2f11a
Show file tree

Hide file tree

Showing 3 changed files with 113 additions and 95 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -7,4 +7,5 @@ docutils
 sphinxcontrib-fulltoc
 sphinxcontrib-mockautodoc
 git+https://github.com/PytorchLightning/lightning_sphinx_theme.git
-# pip_shims
+# pip_shims
+sphinx-autodoc-typehints
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -86,6 +86,7 @@
     'sphinx.ext.autosectionlabel',
     # 'm2r',
     'nbsphinx',
+    'sphinx_autodoc_typehints',
 ]
 
 # Add any paths that contain templates here, relative to this directory.