Merge pull request #11 from letuananh/dev

Add cross-ref between tut_media and api_media
neocl · Apr 30, 2021 · b34849d · b34849d
2 parents 74d9d4e + 402debf
commit b34849d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/docs/api_media.rst b/docs/api_media.rst
@@ -5,5 +5,7 @@ Media module
 
 This is a module for media processing.
 
+For common media code samples, please refer to :ref:`tut_media`. 
+
 .. automodule:: speach.media
    :members: 
diff --git a/docs/media.rst b/docs/media.rst
@@ -1,7 +1,9 @@
+.. _tut_media:
+
 Media processing tutorial
 ==========================
 
-Media module can be used to process audio and video files (converting, merging, cutting, et cetera).
+:mod:`Media module <speach.media>` can be used to process audio and video files (converting, merging, cutting, et cetera).
 ``speach.media`` use ffmpeg underneath.
 
 Installing ffmpeg
@@ -19,3 +21,8 @@ Sample code
    print(media.version())
    print(media.locate_ffmpeg())
    media.convert("infile.mp3", "outfile.wav")
+
+Others
+------
+
+For in-depth information and a complete API reference, please refer to :mod:`speach.media` API page.