Update documentation (#568)

* formatting.

* update datasets.

docs/source/datasets.rst

@@ -25,15 +25,47 @@ All the datasets have almost similar API. They all have two common arguments:
 .. currentmodule:: torchaudio.datasets 
 
 
+COMMONVOICE
+~~~~~~~~~~~
+
+.. autoclass:: COMMONVOICE
+  :members: __getitem__
+  :special-members:
+
+
+LIBRISPEECH
+~~~~~~~~~~~
+
+.. autoclass:: LIBRISPEECH
+  :members: __getitem__
+  :special-members:
+
+
+LJSPEECH
+~~~~~~~~
+
+.. autoclass:: LJSPEECH
+  :members: __getitem__
+  :special-members:
+
+
+SPEECHCOMMANDS
+~~~~~~~~~~~~~~
+
+.. autoclass:: SPEECHCOMMANDS
+  :members: __getitem__
+  :special-members:
+
+
 VCTK
-~~~~~
+~~~~
 
 .. autoclass:: VCTK
   :members: __getitem__
   :special-members:
 
 YESNO
-~~~~~~~~~~~~~
+~~~~~
 
 .. autoclass:: YESNO
   :members: __getitem__

docs/source/functional.rst

@@ -2,94 +2,94 @@
     :class: hidden-section
 
 torchaudio.functional
-======================
+=====================
 
 .. currentmodule:: torchaudio.functional
 
 Functions to perform common audio operations.
 
 :hidden:`istft`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~
 
 .. autofunction:: istft
 
 :hidden:`spectrogram`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: spectrogram
 
 :hidden:`amplitude_to_DB`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: amplitude_to_DB
 
 :hidden:`create_fb_matrix`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: create_fb_matrix
 
 :hidden:`create_dct`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: create_dct
 
 :hidden:`mu_law_encoding`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: mu_law_encoding
 
 :hidden:`mu_law_decoding`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: mu_law_decoding
 
 :hidden:`complex_norm`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: complex_norm
 
 :hidden:`angle`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~
 
 .. autofunction:: angle
 
 :hidden:`magphase`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: magphase
 
 :hidden:`phase_vocoder`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: phase_vocoder
 
 :hidden:`lfilter`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~
 
 .. autofunction:: lfilter
 
 :hidden:`biquad`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~
 
 .. autofunction:: biquad
 
 :hidden:`lowpass_biquad`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: lowpass_biquad
 
 :hidden:`highpass_biquad`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: highpass_biquad
 
 :hidden:`allpass_biquad`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: allpass_biquad
 
 :hidden:`equalizer_biquad`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: equalizer_biquad
 
@@ -139,22 +139,22 @@ Functions to perform common audio operations.
 .. autofunction:: overdrive
 
 :hidden:`mask_along_axis`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: mask_along_axis
 
 :hidden:`mask_along_axis_iid`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: mask_along_axis_iid
 
 :hidden:`compute_deltas`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: compute_deltas
 
 :hidden:`detect_pitch_frequency`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 .. autofunction:: detect_pitch_frequency
 

torchaudio/transforms.py

@@ -838,10 +838,10 @@ class Vol(torch.nn.Module):
 
     Args:
         gain (float): Interpreted according to the given gain_type:
-            If `gain_type’ = ‘amplitude’, `gain’ is a positive amplitude ratio.
-            If `gain_type’ = ‘power’, `gain’ is a power (voltage squared).
-            If `gain_type’ = ‘db’, `gain’ is in decibels.
-        gain_type (str, optional): Type of gain. One of: ‘amplitude’, ‘power’, ‘db’ (Default: ``"amplitude"``)
+            If ``gain_type`` = ``amplitude``, ``gain`` is a positive amplitude ratio.
+            If ``gain_type`` = ``power``, ``gain`` is a power (voltage squared).
+            If ``gain_type`` = ``db``, ``gain`` is in decibels.
+        gain_type (str, optional): Type of gain. One of: ``amplitude``, ``power``, ``db`` (Default: ``amplitude``)
     """
 
     def __init__(self, gain: float, gain_type: str = 'amplitude'):