From 4eff227d1eab1022bc57b0a417a5bd3a59c02f65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gerard=20Braad=20=E2=80=94=20=E5=90=89=E6=8B=89=E5=BE=B7?= Date: Thu, 21 Apr 2016 02:19:52 +0000 Subject: [PATCH] Add table of contents Change-Id: Ib11684415ccf06b6b26f40862b99398c90db832f --- docs/index.rst | 8 ++++++++ docs/multi-node-architecture.rst | 4 ++-- docs/quickstart.rst | 14 ++++---------- 3 files changed, 14 insertions(+), 12 deletions(-) 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.