From 6ef0b4014ad072767ef9745bfa9b0ed4efb7a6cb Mon Sep 17 00:00:00 2001 From: Liangliang He Date: Mon, 2 Jul 2018 17:21:09 +0800 Subject: [PATCH] Refactor document structure --- docs/index.rst | 21 ++++++++++++------ docs/{getting_started => }/introduction.rst | 0 docs/{getting_started => }/mace-arch.png | Bin docs/user_guide/advanced_usage.rst | 3 +++ docs/user_guide/basic_usage.rst | 3 +++ .../create_a_model_deployment.rst | 0 .../how_to_build.rst | 0 docs/user_guide/installation.rst | 3 +++ .../models/demo_app_models.yaml | 0 .../op_lists.rst | 0 10 files changed, 23 insertions(+), 7 deletions(-) rename docs/{getting_started => }/introduction.rst (100%) rename docs/{getting_started => }/mace-arch.png (100%) create mode 100644 docs/user_guide/advanced_usage.rst create mode 100644 docs/user_guide/basic_usage.rst rename docs/{getting_started => user_guide}/create_a_model_deployment.rst (100%) rename docs/{getting_started => user_guide}/how_to_build.rst (100%) create mode 100644 docs/user_guide/installation.rst rename docs/{getting_started => user_guide}/models/demo_app_models.yaml (100%) rename docs/{getting_started => user_guide}/op_lists.rst (100%) diff --git a/docs/index.rst b/docs/index.rst index 5dd29763..e99ea4ab 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,17 +6,24 @@ The main documentation is organized into the following sections: .. toctree:: :maxdepth: 1 - :caption: Getting started - :name: sec-start + :caption: Introduction + :name: sec-intro - getting_started/introduction - getting_started/create_a_model_deployment - getting_started/how_to_build - getting_started/op_lists + introduction .. toctree:: :maxdepth: 1 - :caption: Development + :caption: User guide + :name: sec-user + + user_guide/installation + user_guide/basic_usage + user_guide/advanced_usage + user_guide/op_lists + +.. toctree:: + :maxdepth: 1 + :caption: Developer guide :name: sec-devel development/contributing diff --git a/docs/getting_started/introduction.rst b/docs/introduction.rst similarity index 100% rename from docs/getting_started/introduction.rst rename to docs/introduction.rst diff --git a/docs/getting_started/mace-arch.png b/docs/mace-arch.png similarity index 100% rename from docs/getting_started/mace-arch.png rename to docs/mace-arch.png diff --git a/docs/user_guide/advanced_usage.rst b/docs/user_guide/advanced_usage.rst new file mode 100644 index 00000000..43c66c77 --- /dev/null +++ b/docs/user_guide/advanced_usage.rst @@ -0,0 +1,3 @@ +Advanced usage +============== + diff --git a/docs/user_guide/basic_usage.rst b/docs/user_guide/basic_usage.rst new file mode 100644 index 00000000..d9b60a87 --- /dev/null +++ b/docs/user_guide/basic_usage.rst @@ -0,0 +1,3 @@ +Basic usage +============ + diff --git a/docs/getting_started/create_a_model_deployment.rst b/docs/user_guide/create_a_model_deployment.rst similarity index 100% rename from docs/getting_started/create_a_model_deployment.rst rename to docs/user_guide/create_a_model_deployment.rst diff --git a/docs/getting_started/how_to_build.rst b/docs/user_guide/how_to_build.rst similarity index 100% rename from docs/getting_started/how_to_build.rst rename to docs/user_guide/how_to_build.rst diff --git a/docs/user_guide/installation.rst b/docs/user_guide/installation.rst new file mode 100644 index 00000000..cd7a81df --- /dev/null +++ b/docs/user_guide/installation.rst @@ -0,0 +1,3 @@ +Installation +============ + diff --git a/docs/getting_started/models/demo_app_models.yaml b/docs/user_guide/models/demo_app_models.yaml similarity index 100% rename from docs/getting_started/models/demo_app_models.yaml rename to docs/user_guide/models/demo_app_models.yaml diff --git a/docs/getting_started/op_lists.rst b/docs/user_guide/op_lists.rst similarity index 100% rename from docs/getting_started/op_lists.rst rename to docs/user_guide/op_lists.rst -- GitLab