From 352f5fab4ff861b280cc3cb15c1637639d72ae41 Mon Sep 17 00:00:00 2001
From: liutuo <liutuo@xiaomi.com>
Date: Thu, 5 Jul 2018 17:47:11 +0800
Subject: [PATCH] update

---
 docs/index.rst                        |  1 -
 docs/installation/env_requirement.rst |  6 ++---
 docs/installation/manual_setup.rst    | 12 ++++-----
 docs/installation/using_docker.rst    |  7 +++---
 docs/user_guide/advanced_usage.rst    | 22 ++++++++---------
 docs/user_guide/basic_usage.rst       | 35 ++++++++++++++-------------
 6 files changed, 42 insertions(+), 41 deletions(-)

diff --git a/docs/index.rst b/docs/index.rst
index b293ce45..14411808 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -25,7 +25,6 @@ The main documentation is organized into the following sections:
    :caption: User guide
    :name: sec-user
 
-   user_guide/installation
    user_guide/basic_usage
    user_guide/advanced_usage
    user_guide/op_lists
diff --git a/docs/installation/env_requirement.rst b/docs/installation/env_requirement.rst
index fa66ccff..3efaf8f9 100644
--- a/docs/installation/env_requirement.rst
+++ b/docs/installation/env_requirement.rst
@@ -1,10 +1,10 @@
 Environment Requirement
-=======================
+========================
 
 MACE requires the following dependencies:
 
 Necessary Dependencies:
------------------------
+------------------------
 
 .. list-table::
     :header-rows: 1
@@ -51,7 +51,7 @@ Necessary Dependencies:
     ``export ANDROID_NDK_HOME=/path/to/ndk`` to specify ANDROID_NDK_HOME
 
 Optional Dependencies:
----------------------
+-----------------------
 
 .. list-table::
     :header-rows: 1
diff --git a/docs/installation/manual_setup.rst b/docs/installation/manual_setup.rst
index c6aa39d2..bb283ac4 100644
--- a/docs/installation/manual_setup.rst
+++ b/docs/installation/manual_setup.rst
@@ -1,13 +1,13 @@
 Manual setup
-============
+=============
 
 The setup steps are based on ``Ubuntu``. And dependencies to install can refer to :doc:`env_requirement`.
 
 Install Necessary Dependencies
-------------------------------
+-------------------------------
 
 Install Bazel
-~~~~~~~~~~~~~
+~~~~~~~~~~~~~~
 
 Recommend bazel with version larger than ``0.13.0`` (Refer to `Bazel documentation <https://docs.bazel.build/versions/master/install.html>`__).
 
@@ -23,7 +23,7 @@ Recommend bazel with version larger than ``0.13.0`` (Refer to `Bazel documentati
         rm -f /bazel/bazel-$BAZEL_VERSION-installer-linux-x86_64.sh
 
 Install NDK
-~~~~~~~~~~~
+~~~~~~~~~~~~
 
 Recommend NDK with version r15c or r16 (Refer to `NDK installation guide <https://developer.android.com/ndk/guides/setup#install>`__).
 
@@ -43,7 +43,7 @@ Recommend NDK with version r15c or r16 (Refer to `NDK installation guide <https:
     export PATH=${PATH}:${ANDROID_NDK_HOME}
 
 Install extra tools
-~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~
 
 .. code:: sh
 
@@ -61,7 +61,7 @@ Install extra tools
         filelock
 
 Install Optional Dependencies
------------------------------
+------------------------------
 
 .. code:: sh
 
diff --git a/docs/installation/using_docker.rst b/docs/installation/using_docker.rst
index b6f3ea49..c064e6fc 100644
--- a/docs/installation/using_docker.rst
+++ b/docs/installation/using_docker.rst
@@ -1,8 +1,8 @@
 Using docker
-============
+=============
 
 Pull or Build docker image
---------------------------
+---------------------------
 
 MACE provides docker images with necessary dependencies installed and also Dockerfiles for images building,
 you can pull the existing ones directly or build them from the Dockerfiles.
@@ -33,8 +33,9 @@ In most cases, the ``lite edition`` image can satify developer's basic needs.
 
     We will show steps with lite edition later.
 
+
 Using the image
----------------
+-----------------
 
 Create container with the following command
 
diff --git a/docs/user_guide/advanced_usage.rst b/docs/user_guide/advanced_usage.rst
index 3d7e5503..0d551d00 100644
--- a/docs/user_guide/advanced_usage.rst
+++ b/docs/user_guide/advanced_usage.rst
@@ -1,23 +1,23 @@
 Advanced usage
-==============
+===============
 
 This part contains the full usage of MACE.
 
 
 How to build
---------------------------------
+-------------
 
 
-====================
+=========
 Overview
-====================
+=========
 
 As mentioned in the previous part, a model deployment file defines a case of model deployment.
 The whole building process is loading a deployment file, converting models, building MACE and packing generated files.
 
-====================
+================
 Deployment file
-====================
+================
 
 
 One deployment file will generate one library normally, but if more than one ABIs are specified,
@@ -111,9 +111,9 @@ in one deployment file.
         sha256sum path/to/your/file
 
 
-====================
+=========
 Building
-====================
+=========
 
 * **Build static or shared library**
 
@@ -246,12 +246,12 @@ Use ``-h`` to get detailed help.
 
 
 How to deploy
---------------------------------
+--------------
 
 
-========================
+=========
 Overview
-========================
+=========
 
 ``build`` command will generate the static/shared library, model files and
 header files and package them as
diff --git a/docs/user_guide/basic_usage.rst b/docs/user_guide/basic_usage.rst
index de58ce6e..ade39b63 100644
--- a/docs/user_guide/basic_usage.rst
+++ b/docs/user_guide/basic_usage.rst
@@ -1,11 +1,11 @@
 Basic usage
-=============
+============
 
 
 Build and run an example model
---------------------------------
+-------------------------------
 
-At first, make sure the environment has been set up correctly already (refer to :doc:`installation`).
+At first, make sure the environment has been set up correctly already (refer to :doc:`../installation/env_requirement`).
 
 The followings are instructions about  how to quickly build and run a provided model in *MACE Model Zoo*.
 
@@ -67,13 +67,13 @@ Here we use the mobilenet-v2 model as an example.
 
 
 Build your own model
-----------------------------
+---------------------
 
 This part will show you how to use your pre-trained model in MACE.
 
-==================================
+======================
 1. Prepare your model
-==================================
+======================
 
 Mace now supports models from Tensorflow and Caffe(more frameworks will be supported).
 
@@ -121,9 +121,9 @@ Mace now supports models from Tensorflow and Caffe(more frameworks will be suppo
        $CAFFE_ROOT/build/tools/upgrade_net_proto_binary MODEL.caffemodel MODEL.new.caffemodel
 
 
-============================================
+===========================================
 2. Create a deployment file for your model
-============================================
+===========================================
 
 When converting a model or building a library, MACE needs to read a YAML file which is called model deployment file here.
 
@@ -145,9 +145,9 @@ Modify one of them and use it for your own case.
 
 More details about model deployment file, please refer to :doc:`advanced_usage`.
 
-======================================
+======================
 3. Convert your model
-======================================
+======================
 
 When the deployment file is ready for your model, you can use MACE converter tool to convert your model(s).
 
@@ -167,9 +167,9 @@ The generated model files will be stored in ``build/${library_name}/model`` fold
     Please set ``build_type:proto`` in your deployment file before converting.
     The usage of ``build_type:code`` will be demonstrated in :doc:`advanced_usage`.
 
-======================================
+=============================
 4. Build MACE into a library
-======================================
+=============================
 
 MACE can be built into either a static or a shared library (which is
 specified by ``linkshared`` in YAML model deployment file).
@@ -190,11 +190,12 @@ The above command will generate library files in the ``build/${library_name}/lib
         2. If you want to build a library for a specific soc, please refer to :doc:`advanced_usage`.
 
 
-======================================
+==================
 5. Run your model
-======================================
+==================
 
-With the converted model, *.so or *.a library and header files, you can use the following commands to run and validate your model.
+With the converted model, the static or shared library and header files, you can use the following commands
+to run and validate your model.
 
 * **run**
 
@@ -219,9 +220,9 @@ With the converted model, *.so or *.a library and header files, you can use the
         python tools/converter.py benchmark --config=path/to/your/model_deployment_file.yml
 
 
-========================================================
+=======================================
 6. Deploy your model into applications
-========================================================
+=======================================
 
 In the converting and building steps, you've got the static/shared library, model files and
 header files. All of these generated files have been packaged into
-- 
GitLab