resolving documentation warnings (#833)

* add more underline

* fix LightningMudule import error

* remove unneeded blank line

* escape asterisk to fix inline emphasis warning

* add PULL_REQUEST_TEMPLATE.md

* add __init__.py and import imagenet_example

* fix duplicate label

* add noindex option to fix duplicate object warnings

* remove unexpected indent

* refer explicit LightningModule

* fix minor bug

* refer EarlyStopping explicitly

* restore exclude patterns

* change the way how to refer class

* remove unused import

* update badges & drop Travis/Appveyor (#826)

* drop Travis

* drop Appveyor

* update badges

* fix missing PyPI images & CI badges (#853)

* docs - anchor links (#848)

* docs - add links

* add desc.

* add Greeting action (#843)

* add Greeting action

* Update greetings.yml

Co-authored-by: William Falcon <waf2107@columbia.edu>

* add pep8speaks (#842)

* advanced profiler describe + cleaned up tests (#837)

* add py36 compatibility

* add test case to capture previous bug

* clean up tests

* clean up tests

* Update lightning_module_template.py

* Update lightning.py

* respond lint issues

* break long line

* break more lines

* checkout conflicting files from master

* shorten url

* checkout from upstream/master

* remove trailing whitespaces

* remove unused import LightningModule

* fix sphinx bot warnings

* Apply suggestions from code review

just to trigger CI

* Update .github/workflows/greetings.yml

Co-authored-by: Jirka Borovec <Borda@users.noreply.github.com>
Co-authored-by: William Falcon <waf2107@columbia.edu>
Co-authored-by: Jeremy Jordan <13970565+jeremyjordan@users.noreply.github.com>

docs/source/callbacks.rst

@@ -4,6 +4,7 @@
 Callbacks
 =========
 .. automodule:: pytorch_lightning.callbacks
+   :noindex:
    :exclude-members:
         _del_model,
         _save_model,
@@ -11,4 +12,4 @@ Callbacks
         on_train_end,
         on_epoch_start,
         check_monitor_top_k,
-        on_train_start,
+        on_train_start,

docs/source/checkpointing.rst

@@ -71,7 +71,7 @@ If you want to pick up training from where you left off, you have a few options.
    trainer = Trainer(logger=logger)
    trainer.fit(model)
 
-2. A second option is to pass in a path to a checkpoint (see: :ref:`pytorch_lightning.trainer`).
+2. A second option is to pass in a path to a checkpoint (see: :ref:`pytorch_lightning.trainer.trainer.Trainer`).
 
 .. code-block:: python
 

docs/source/conf.py

@@ -355,10 +355,10 @@ autoclass_content = 'both'
 autodoc_default_options = {
     'members': None,
     'special-members': '__call__',
-    'undoc-members': True,
     # 'exclude-members': '__weakref__',
     'show-inheritance': True,
     'private-members': True,
+    'noindex': True,
 }
 
 # Sphinx will add “permalinks” for each heading and description environment as paragraph signs that

docs/source/index.rst

@@ -71,6 +71,7 @@ PyTorch-Lightning Documentation
    CODE_OF_CONDUCT.md
    CONTRIBUTING.md
    BECOMING_A_CORE_CONTRIBUTOR.md
+   PULL_REQUEST_TEMPLATE.md
    governance.md
 
 Indices and tables

docs/source/lightning-module.rst

@@ -5,6 +5,7 @@ LightningModule
 ===============
 
 .. automodule:: pytorch_lightning.core
+   :noindex:
    :exclude-members:
         _abc_impl,
         summarize,

docs/source/loggers.rst

@@ -4,6 +4,7 @@
 Loggers
 ===========
 .. automodule:: pytorch_lightning.loggers
+   :noindex:
    :exclude-members:
         _abc_impl,
         _save_model,

docs/source/optimizers.rst

@@ -53,9 +53,9 @@ Lightning will call each optimizer sequentially:
 
 
 Step optimizers at arbitrary intervals
--------------------------------------
+----------------------------------------
 To do more interesting things with your optimizers such as learning rate warm-up or odd scheduling,
-override the :meth:`optimizer_step' function.
+override the :meth:`optimizer_step` function.
 
 For example, here step optimizer A every 2 batches and optimizer B every 4 batches
 
@@ -96,4 +96,4 @@ Here we add a learning-rate warm up
 
         # update params
         optimizer.step()
-        optimizer.zero_grad()
+        optimizer.zero_grad()

docs/source/profiler.rst

@@ -3,8 +3,9 @@
 
 
 Performance and Bottleneck Profiler
-===========
+===================================
 .. automodule:: pytorch_lightning.profiler
+   :noindex:
    :exclude-members:
         _abc_impl,
         summarize,

docs/source/trainer.rst

@@ -6,6 +6,7 @@ Trainer
 
 .. automodule:: pytorch_lightning.trainer
    :members: fit, test
+   :noindex:
    :exclude-members: 
         run_pretrain_routine, 
         _abc_impl,