diff --git a/docs/index.rst b/docs/index.rst index 5dd297637b2375df6087d5d51f8cc609111fa622..e99ea4ab1d7ccc38e16da4ae11c76451c7a43bb8 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 0000000000000000000000000000000000000000..43c66c771df3d925b09cd57f32a2803f3cf88841 --- /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 0000000000000000000000000000000000000000..d9b60a87fa713161ba449bcf65cedd2452348795 --- /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 0000000000000000000000000000000000000000..cd7a81df9f56604f1ed80077d0406da87503e2f2 --- /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