update Docs [links & formatting] (#769)

* wip

* wip

* debug imports
docs formatting

* WIP

* formatting

* fix setup

docs/requirements.txt

@@ -4,7 +4,7 @@ m2r  # fails with multi-line text
 nbsphinx
 pandoc
 docutils
-git+https://github.com/PytorchLightning/lightning_sphinx_theme.git
 sphinxcontrib-fulltoc
 sphinxcontrib-mockautodoc
-pip_shims
+git+https://github.com/PytorchLightning/lightning_sphinx_theme.git
+# pip_shims

docs/source/conf.py

@@ -348,7 +348,11 @@ def linkcode_resolve(domain, info):
 
 autodoc_member_order = 'groupwise'
 autoclass_content = 'both'
-autodoc_default_flags = [
-    'members', 'undoc-members', 'show-inheritance', 'private-members',
-    # 'special-members', 'inherited-members'
-]
+autodoc_default_options = {
+    'members': True,
+    'special-members': '__call__',
+    'undoc-members': True,
+    # 'exclude-members': '__weakref__',
+    'show-inheritance': True,
+    'private-members': True,
+}

docs/source/documentation.rst

@@ -1,8 +0,0 @@
-Documentation
-=============
-
-
-.. toctree::
-   :maxdepth: 4
-
-   pytorch_lightning

docs/source/index.rst

@@ -4,7 +4,7 @@
    contain the root `toctree` directive.
 
 PyTorch-Lightning Documentation
-=============================
+===============================
 
 .. toctree::
    :maxdepth: 1

docs/source/lightning-module.rst

@@ -2,7 +2,8 @@
     :class: hidden-section
 
 LightningModule
-===========
+===============
+
 .. automodule:: pytorch_lightning.core
    :exclude-members:
         _abc_impl,

docs/source/modules.rst

@@ -1,7 +0,0 @@
-pl_examples
-===========
-
-.. toctree::
-   :maxdepth: 4
-
-   pl_examples

docs/source/tutorials.rst

@@ -1,20 +1,20 @@
 Refactoring PyTorch into Lightning
-==================================
-`Tutorial <https://towardsdatascience.com/how-to-refactor-your-pytorch-code-to-get-these-42-benefits-of-pytorch-lighting-6fdd0dc97538>`_
+----------------------------------
+`How to refactor your PyTorch code to get these 42 benefits of PyTorch-Lighting <https://towardsdatascience.com/how-to-refactor-your-pytorch-code-to-get-these-42-benefits-of-pytorch-lighting-6fdd0dc97538>`_
 
 Start a research project
-=========================
+------------------------
 `Research seed <https://github.com/PytorchLightning/pytorch-lightning-conference-seed>`_
 
 Basic Lightning use
-====================
-`Tutorial <https://towardsdatascience.com/supercharge-your-ai-research-with-pytorch-lightning-337948a99eec>`_
+-------------------
+`Supercharge your AI research with PyTorch-Lightning <https://towardsdatascience.com/supercharge-your-ai-research-with-pytorch-lightning-337948a99eec>`_
 
 9 key Lightning  tricks
-========================
-`Tutorial <https://towardsdatascience.com/9-tips-for-training-lightning-fast-neural-networks-in-pytorch-8e63a502f565>`_
+-----------------------
+`Tutorial on 9 key speed features in PyTorch-Lightning <9 key speed features in Pytorch-Lightning>`_
 
 Multi-node training on SLURM
-=============================
-`Tutorial <https://towardsdatascience.com/trivial-multi-node-training-with-pytorch-lightning-ff75dfb809bd>`_
+----------------------------
+`Trivial multi node training with PyTorch-Lightning <https://towardsdatascience.com/trivial-multi-node-training-with-pytorch-lightning-ff75dfb809bd>`_