docs(tutorial): add yaml explain

gnes-ai · Jul 26, 2019 · afd5dda · afd5dda
1 parent 9bee5d3
commit afd5dda
Show file tree

Hide file tree

Showing 10 changed files with 1,243 additions and 413 deletions.
diff --git a/README.md b/README.md
@@ -545,7 +545,7 @@ The official documentation of GNES is hosted on [doc.gnes.ai](https://doc.gnes.a
 
 > 🚧 Tutorial is still under construction. Stay tuned! Meanwhile, we sincerely welcome you to contribute your own learning experience / case study with GNES! 
 
-- How to write your GNES YAML config
+- [How to write your GNES YAML config](tutorials/gnes-yaml-specifications.md)
 - How to write a component-wise YAML config
 - Understanding preprocessor, encoder, indexer and router
 - Index and query text data with GNES

diff --git a/docs/conf.py b/docs/conf.py
@@ -54,9 +54,11 @@
     'sphinx.ext.viewcode',
     'sphinxcontrib.apidoc',
     'sphinxarg.ext',
-    'recommonmark'
+    'recommonmark',
+    'sphinx_markdown_tables',
 ]
 
+
 apidoc_module_dir = '../gnes'
 apidoc_output_dir = 'api'
 apidoc_excluded_paths = ['tests']

diff --git a/docs/index.rst b/docs/index.rst
@@ -51,14 +51,14 @@ Highlights
 
 .. toctree::
    :maxdepth: 3
-   :caption: Microservices API
+   :caption: GNES Microservices API
 
    chapter/microservice.rst
 
 
 .. toctree::
    :maxdepth: 3
-   :caption: Module API
+   :caption: GNES Modules
 
    api/gnes
 
@@ -83,11 +83,13 @@ Tutorials
    🚧 Tutorial is still under construction. Stay tuned! Meanwhile, we sincerely welcome you to contribute your own learning experience / case study with GNES!
 
 
+Miscs
+-----
+
 .. toctree::
    :maxdepth: 1
+   :caption: Miscs
 
-   chapter/overview.md
-   chapter/yaml-config.md
    chapter/troubleshooting.md
    chapter/protobuf-dev.md
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,3 @@
 sphinx-argparse
-sphinxcontrib-apidoc
+sphinxcontrib-apidoc
+sphinx-markdown-tables