torch.functional Docs (pytorch#140)

.gitignore

@@ -68,6 +68,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/src/
 
 # PyBuilder
 target/

docs/source/conf.py

@@ -208,6 +208,7 @@ def setup(app):
 intersphinx_mapping = {
     'python': ('https://docs.python.org/', None),
     'numpy': ('https://docs.scipy.org/doc/numpy/', None),
+    'torch': ('https://pytorch.org/docs/stable/', None),
 }
 
 # -- A patch that prevents Sphinx from cross-referencing ivar tags -------

docs/source/functional.rst

@@ -0,0 +1,70 @@
+.. role:: hidden
+    :class: hidden-section
+
+torchaudio.functional
+======================
+
+.. currentmodule:: torchaudio.functional
+
+Functions to perform common audio operations.
+
+:hidden:`scale`
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: scale
+
+
+:hidden:`pad_trim`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: pad_trim
+
+:hidden:`downmix_mono`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: downmix_mono
+
+:hidden:`LC2CL`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: LC2CL
+
+:hidden:`istft`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: istft
+
+:hidden:`spectrogram`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: spectrogram
+
+:hidden:`create_fb_matrix`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: create_fb_matrix
+
+:hidden:`spectrogram_to_DB`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: spectrogram_to_DB
+
+:hidden:`create_dct`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: create_dct
+
+:hidden:`BLC2CBL`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: BLC2CBL
+
+:hidden:`mu_law_encoding`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: mu_law_encoding
+
+:hidden:`mu_law_expanding`
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: mu_law_expanding

docs/source/index.rst

@@ -12,6 +12,7 @@ The :mod:`torchaudio` package consists of I/O, popular datasets and common audio
    compliance.kaldi
    kaldi_io
    transforms
+   functional
    legacy
 
 .. automodule:: torchaudio