Add toctrees for methods and classes for contrib package

Author: trsvchn

docs/source/contrib/engines.rst

@@ -5,6 +5,19 @@ Contribution module of engines and helper tools
 
 .. currentmodule:: ignite.contrib.engines
 
+.. currentmodule:: ignite.contrib.engines.tbptt
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
+
+.. currentmodule:: ignite.contrib.engines.common
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
 
 Truncated Backpropagation Throught Time
 ---------------------------------------

docs/source/contrib/handlers.rst

@@ -7,28 +7,58 @@ Contribution module of handlers
 param_scheduler
 ---------------
 
+.. currentmodule:: ignite.contrib.handlers.param_scheduler
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
+
 .. automodule:: ignite.contrib.handlers.param_scheduler
    :members:
 
+
 lr_finder
 ---------
 
+.. currentmodule:: ignite.contrib.handlers.lr_finder
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
+
 .. automodule:: ignite.contrib.handlers.lr_finder
    :members:
 
 
 time_profilers
 ---------------
 
+.. currentmodule:: ignite.contrib.handlers.time_profilers
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
+
+
 .. automodule:: ignite.contrib.handlers.time_profilers
    :members:
 
+
 tensorboard_logger
 ------------------
 
 See `tensorboardX mnist example <https://github.com/pytorch/ignite/blob/master/examples/contrib/mnist/mnist_with_tensorboard_logger.py>`_
 and `CycleGAN and EfficientNet notebooks <https://github.com/pytorch/ignite/tree/master/examples/notebooks>`_ for detailed usage.
 
+.. currentmodule:: ignite.contrib.handlers.tensorboard_logger
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
 
 .. automodule:: ignite.contrib.handlers.tensorboard_logger
    :members:
@@ -41,6 +71,13 @@ visdom_logger
 See `visdom mnist example <https://github.com/pytorch/ignite/blob/master/examples/contrib/mnist/mnist_with_visdom_logger.py>`_
 for detailed usage.
 
+.. currentmodule:: ignite.contrib.handlers.visdom_logger
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
+
 .. automodule:: ignite.contrib.handlers.visdom_logger
    :members:
    :inherited-members:
@@ -52,6 +89,12 @@ neptune_logger
 See `neptune mnist example <https://github.com/pytorch/ignite/blob/master/examples/contrib/mnist/mnist_with_neptune_logger.py>`_
 for detailed usage.
 
+.. currentmodule:: ignite.contrib.handlers.neptune_logger
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
 
 .. automodule:: ignite.contrib.handlers.neptune_logger
    :members:
@@ -61,6 +104,13 @@ for detailed usage.
 mlflow_logger
 -------------
 
+.. currentmodule:: ignite.contrib.handlers.mlflow_logger
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
+
 .. automodule:: ignite.contrib.handlers.mlflow_logger
    :members:
    :inherited-members:
@@ -72,13 +122,26 @@ tqdm_logger
 See `tqdm mnist example <https://github.com/pytorch/ignite/blob/master/examples/contrib/mnist/mnist_with_tqdm_logger.py>`_
 for detailed usage.
 
+.. currentmodule:: ignite.contrib.handlers.tqdm_logger
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
 
 .. automodule:: ignite.contrib.handlers.tqdm_logger
    :members:
 
 polyaxon_logger
 ---------------
 
+.. currentmodule:: ignite.contrib.handlers.polyaxon_logger
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
+
 .. automodule:: ignite.contrib.handlers.polyaxon_logger
    :members:
    :inherited-members:
@@ -89,6 +152,13 @@ wandb_logger
 See `wandb mnist example <https://github.com/pytorch/ignite/blob/master/examples/contrib/mnist/mnist_with_wandb_logger.py>`_
 for detailed usage.
 
+.. currentmodule:: ignite.contrib.handlers.wandb_logger
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
+
 .. automodule:: ignite.contrib.handlers.wandb_logger
    :members:
    :inherited-members:
@@ -99,6 +169,13 @@ trains_logger
 See `trains mnist example <https://github.com/pytorch/ignite/blob/master/examples/contrib/mnist/mnist_with_trains_logger.py>`_
 for detailed usage.
 
+.. currentmodule:: ignite.contrib.handlers.trains_logger
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
+
 .. automodule:: ignite.contrib.handlers.trains_logger
    :members:
    :inherited-members:

docs/source/contrib/metrics.rst

@@ -5,6 +5,11 @@ Contribution module of metrics
 
 .. currentmodule:: ignite.contrib.metrics
 
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
+
 .. automodule:: ignite.contrib.metrics
    :members:
    :imported-members:
@@ -26,21 +31,12 @@ metrics useful for regression tasks. Definitions of metrics are based on `Botchk
 
 Complete list of metrics:
 
-    - :class:`~ignite.contrib.metrics.regression.CanberraMetric`
-    - :class:`~ignite.contrib.metrics.regression.FractionalAbsoluteError`
-    - :class:`~ignite.contrib.metrics.regression.FractionalBias`
-    - :class:`~ignite.contrib.metrics.regression.GeometricMeanAbsoluteError`
-    - :class:`~ignite.contrib.metrics.regression.GeometricMeanRelativeAbsoluteError`
-    - :class:`~ignite.contrib.metrics.regression.ManhattanDistance`
-    - :class:`~ignite.contrib.metrics.regression.MaximumAbsoluteError`
-    - :class:`~ignite.contrib.metrics.regression.MeanAbsoluteRelativeError`
-    - :class:`~ignite.contrib.metrics.regression.MeanError`
-    - :class:`~ignite.contrib.metrics.regression.MeanNormalizedBias`
-    - :class:`~ignite.contrib.metrics.regression.MedianAbsoluteError`
-    - :class:`~ignite.contrib.metrics.regression.MedianAbsolutePercentageError`
-    - :class:`~ignite.contrib.metrics.regression.MedianRelativeAbsoluteError`
-    - :class:`~ignite.contrib.metrics.regression.R2Score`
-    - :class:`~ignite.contrib.metrics.regression.WaveHedgesDistance`
+.. currentmodule:: ignite.contrib.metrics.regression
+
+.. autosummary::
+    :toctree:
+    :nosignatures:
+    :autolist:
 
 
 .. autoclass:: CanberraMetric