diff --git a/docs/index.rst b/docs/index.rst index b25251a..f995848 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -48,3 +48,11 @@ Steth is an introspection tool for OpenStack networking. Only proved to be working in ML2 with OVS for now. +Table of Contents +================= + +.. toctree:: + :maxdepth: 2 + + Quickstart + Multi-node architecture diff --git a/docs/multi-node-architecture.rst b/docs/multi-node-architecture.rst index f9121b0..53f660a 100644 --- a/docs/multi-node-architecture.rst +++ b/docs/multi-node-architecture.rst @@ -1,6 +1,6 @@ ------------------------ +======================= Multi-node Architecture ------------------------ +======================= :: diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 495ddf3..b20ed6c 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -1,17 +1,11 @@ -=============================== -Steth's developer documentation -=============================== +========== +Quickstart +========== + Steth is an inspection tool that can aid in pinpointing issues before deployment and during operation of an OpenStack environment. - ------------ -Quick start ------------ - -Steth is a network inspection tool for OpenStack. - It is modelled as agent(s)/client in which a controller interacts with agents deployed in your environment. Let me introduce how to use steth.