[docs] update docs

cmusatyalab · Apr 20, 2020 · 2af3b7a · 2af3b7a
1 parent d5d0320
commit 2af3b7a
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 13 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -45,7 +45,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u''
+project = u'OpenWorkflow\'s Doc'
 copyright = u"2020, Carnegie Mellon University"
 author = u"Junjue Wang"
 
@@ -72,7 +72,7 @@
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-add_module_names = True
+add_module_names = False
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'

diff --git a/docs/index.rst b/docs/index.rst
@@ -21,7 +21,7 @@ User Guide
    installation
    quickstart
    tutorial
-   modules
+   source/modules
    contributing
    history
 

diff --git a/docs/modules.rst b/docs/modules.rst
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -1,5 +1,5 @@
-gabrieltool
-===========
+gabrieltool API
+===============
 
 .. toctree::
    :maxdepth: 4

diff --git a/docs/tutorial.rst b/docs/tutorial.rst
@@ -4,10 +4,10 @@ Tutorial
 **********************
 
 We will create a wearable cognitive assistant that recognize a person or a chair
-in this tutorial. The complete code is `here
+in this tutorial. The `complete code
 <https://github.com/cmusatyalab/OpenWorkflow/blob/master/examples/gabriel_example.py>`_.
-The code contains a few more use cases of gabrieltool package. We
-will focus on creating a gabriel server in this example.
+contains a few more use cases of gabrieltool package. We will focus on
+creating a gabriel server in this example.
 
 To recognize a person or a chair, we will use a SSD MobileNet v2 object detector
 network from Tensorflow. Download and decompress the detector from