Merge pull request #9 from vicchuayh/mediadev

updated docs for api_media and contributing
neocl · Apr 30, 2021 · 74d9d4e · 74d9d4e
2 parents 1baea43 + 6363c22
commit 74d9d4e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/docs/api_media.rst b/docs/api_media.rst
@@ -1,8 +1,9 @@
-.. _page_vtt:
+.. _api_media:
 
 Media module
 ============
 
+This is a module for media processing.
 
 .. automodule:: speach.media
    :members: 
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -58,7 +58,7 @@ Updating Documentation
 
    .. code:: bash
 
-      cd speach/docs
+      cd docs
       # compile the docs
       make dirhtml
       # serve the docs using Python3 built-in development server
@@ -69,6 +69,9 @@ Updating Documentation
       cd _build/dirhtml
       python3 -m http.server 7000
 
+      # if you use Windows, you may use
+      python -m http.server 7000 --directory _build/dirhtml
+
 #. Now the docs should be ready to view at http://localhost:7000 . You can visit that URL on your browser to view the docs.
 
 #. More information: