Repository: pytorch/ignite

Issue:
Improve docs for common.setup_common_training_handlers
## 🚀 Feature

Idea is to fix rendering (see below) and add an example of usage and a link where [it is used](https://github.com/pytorch/ignite/blob/c6673710fcd78949e0bf203ed9155e82ef639061/examples/contrib/cifar10/main.py#L322).

<img width="715" alt="Screen Shot 2020-08-29 at 22 56 07" src="https://user-images.githubusercontent.com/2459423/91645982-db8aaf00-ea4a-11ea-96d2-e284819cb767.png">

What is wrong: gray frame with red vertical line should be absent for the text "Helper method to setup trainer with common handlers "

https://pytorch.org/ignite/contrib/engines.html#ignite.contrib.engines.common.setup_common_training_handlers

Same for other methods:
- common.setup_common_distrib_training_handlers
- common.setup_*_logging

For Hacktoberfest contributors, feel free to ask questions for details if any and say that you would like to tackle the issue.
Please, take a look at [CONTRIBUTING guide](https://github.com/pytorch/ignite/blob/master/CONTRIBUTING.md).


Discussion:
Assign it to me I shall work on it.@vfdev-5 
@rexdivakar sure
@rexdivakar any updates on this ?
Working on this will raise a PR soon
@rexdivakar sounds good. It would be nice to have the PR on tuesday. As you have 3 issues assigned we'd like to have some activity on these issues without blocking other users who'd like to help out.
oh k will do it soon @vfdev-5 
@rexdivakar could you please send a PR for this issue within 2 days, otherwise unfortunately I'll have to unassign you.
I’d like to look into this
@vfdev-5 should the gray frame with red vertical line be present for "Parameters" title?
@BanzaiTokyo yes, this is OK, see the docs for other correctly rendered methods, e.g. https://pytorch.org/ignite/contrib/engines.html#ignite.contrib.engines.tbptt.create_supervised_tbptt_trainer

Resolving patch:
diff --git a/ignite/contrib/engines/common.py b/ignite/contrib/engines/common.py
--- a/ignite/contrib/engines/common.py
+++ b/ignite/contrib/engines/common.py
@@ -49,6 +49,7 @@ def setup_common_training_handlers(
     **kwargs: Any
 ):
     """Helper method to setup trainer with common handlers (it also supports distributed configuration):
+
         - :class:`~ignite.handlers.TerminateOnNan`
         - handler to setup learning rate scheduling
         - :class:`~ignite.handlers.ModelCheckpoint`
@@ -312,6 +313,7 @@ def setup_tb_logging(
     **kwargs: Any
 ):
     """Method to setup TensorBoard logging on trainer and a list of evaluators. Logged metrics are:
+
         - Training metrics, e.g. running average loss values
         - Learning rate(s)
         - Evaluation metrics
@@ -343,6 +345,7 @@ def setup_visdom_logging(
     **kwargs: Any
 ):
     """Method to setup Visdom logging on trainer and a list of evaluators. Logged metrics are:
+
         - Training metrics, e.g. running average loss values
         - Learning rate(s)
         - Evaluation metrics
@@ -373,6 +376,7 @@ def setup_mlflow_logging(
     **kwargs: Any
 ):
     """Method to setup MLflow logging on trainer and a list of evaluators. Logged metrics are:
+
         - Training metrics, e.g. running average loss values
         - Learning rate(s)
         - Evaluation metrics
@@ -403,6 +407,7 @@ def setup_neptune_logging(
     **kwargs: Any
 ):
     """Method to setup Neptune logging on trainer and a list of evaluators. Logged metrics are:
+
         - Training metrics, e.g. running average loss values
         - Learning rate(s)
         - Evaluation metrics
@@ -433,6 +438,7 @@ def setup_wandb_logging(
     **kwargs: Any
 ):
     """Method to setup WandB logging on trainer and a list of evaluators. Logged metrics are:
+
         - Training metrics, e.g. running average loss values
         - Learning rate(s)
         - Evaluation metrics
@@ -463,6 +469,7 @@ def setup_plx_logging(
     **kwargs: Any
 ):
     """Method to setup Polyaxon logging on trainer and a list of evaluators. Logged metrics are:
+
         - Training metrics, e.g. running average loss values
         - Learning rate(s)
         - Evaluation metrics
@@ -493,6 +500,7 @@ def setup_trains_logging(
     **kwargs: Any
 ):
     """Method to setup Trains logging on trainer and a list of evaluators. Logged metrics are:
+
         - Training metrics, e.g. running average loss values
         - Learning rate(s)
         - Evaluation metrics


Test patch: