fix links to Docs

README.md

@@ -84,12 +84,12 @@ Lightning sets up all the boilerplate state-of-the-art training for you so you c
 ---
 
 ## How do I do use it?   
-Think about Lightning as refactoring your research code instead of using a new framework. The research code goes into a [LightningModule](https://pytorch-lightning.rtfd.io/en/latest/LightningModule/RequiredTrainerInterface/) which you fit using a Trainer.
+Think about Lightning as refactoring your research code instead of using a new framework. The research code goes into a [LightningModule](https://pytorch-lightning.rtfd.io/en/latest/lightning-module.html) which you fit using a Trainer.
 
 The LightningModule defines a *system* such as seq-2-seq, GAN, etc... It can ALSO define a simple classifier such as the example below.     
 
 To use lightning do 2 things:  
-1. [Define a LightningModule](https://pytorch-lightning.rtfd.io/en/latest/LightningModule/RequiredTrainerInterface/)
+1. [Define a LightningModule](https://pytorch-lightning.rtfd.io/en/latest/lightning-module.html)
 **WARNING:** This syntax is for version 0.5.0+ where abbreviations were removed.
     ```python
     import os
@@ -165,7 +165,7 @@ To use lightning do 2 things:
             # OPTIONAL
             return DataLoader(MNIST(os.getcwd(), train=False, download=True, transform=transforms.ToTensor()), batch_size=32)
     ```
-2. Fit with a [trainer](https://pytorch-lightning.rtfd.io/en/latest/Trainer/)    
+2. Fit with a [trainer](https://pytorch-lightning.rtfd.io/en/latest/pytorch_lightning.trainer.html)    
     ```python
     from pytorch_lightning import Trainer
 

docs/source/conf.py

@@ -318,7 +318,7 @@ def find_source():
             obj = getattr(obj, part)
         fname = inspect.getsourcefile(obj)
         # https://github.com/rtfd/readthedocs.org/issues/5735
-        if any([s in fname for s in ('readthedocs', 'checkouts')]):
+        if any([s in fname for s in ('readthedocs', 'rtfd', 'checkouts')]):
             # /home/docs/checkouts/readthedocs.org/user_builds/pytorch_lightning/checkouts/
             #  devel/pytorch_lightning/utilities/cls_experiment.py#L26-L176
             path_top = os.path.abspath(os.path.join('..', '..', '..'))
@@ -338,6 +338,10 @@ def find_source():
     # import subprocess
     # tag = subprocess.Popen(['git', 'rev-parse', 'HEAD'], stdout=subprocess.PIPE,
     #                        universal_newlines=True).communicate()[0][:-1]
+    branch = filename.split('/')[0]
+    # do mapping from latest tags to master
+    branch = {'latest': 'master', 'stable': 'master'}.get(branch, branch)
+    filename = '/'.join([branch] + filename.split('/')[1:])
     return "https://github.com/%s/%s/blob/%s" \
            % (github_user, github_repo, filename)
 

docs/source/examples.rst

@@ -1,33 +1,33 @@
 GAN
-====
+===
 .. toctree::
    :maxdepth: 3
 
    pl_examples.domain_templates.gan
 
 MNIST
-====
+=====
 .. toctree::
    :maxdepth: 3
 
    pl_examples.basic_examples.lightning_module_template
 
 Multi-node (ddp) MNIST
-====
+======================
 .. toctree::
    :maxdepth: 3
 
    pl_examples.multi_node_examples.multi_node_ddp_demo
 
 Multi-node (ddp2) MNIST
-====
+=======================
 .. toctree::
    :maxdepth: 3
 
    pl_examples.multi_node_examples.multi_node_ddp2_demo
 
 Imagenet
-====
+========
 .. toctree::
    :maxdepth: 3
 

pytorch_lightning/callbacks/pt_callbacks.py

@@ -1,6 +1,7 @@
 """
 Callbacks
-====================================
+=========
+
 Callbacks supported by Lightning
 """
 

pytorch_lightning/core/__init__.py

@@ -85,6 +85,7 @@ def test_dataloader(self):
 Once you've defined the LightningModule, fit  it using a trainer.
 
 .. code-block:: python
+
    trainer = pl.Trainer()
    model = CoolModel()
 

pytorch_lightning/logging/__init__.py

@@ -3,6 +3,7 @@
 To use a logger, simply pass it into the trainer.
 
 .. code-block:: python
+
     from pytorch_lightning import logging
 
     # lightning uses tensorboard by default

pytorch_lightning/logging/test_tube.py

@@ -46,7 +46,7 @@ class TestTubeLogger(LightningLoggerBase):
     `os.path.join(save_dir, name, version)`
 
     Example
-    --------
+    -------
 
     .. code-block:: python