From db910447b8b66d00f83eed83a08b86cc857c39bf Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 6 Jun 2018 20:17:59 +0000 Subject: [PATCH] doc: reorganize into multiple toctrees Use multiple toctrees to reorganize the user docs into logical sections. Signed-off-by: Quentin Young --- doc/user/basic.rst | 2 +- doc/user/getting-started.rst | 9 ------- doc/user/index.rst | 30 ++++++++++++++++++--- doc/user/{appendix.rst => packet-dumps.rst} | 0 4 files changed, 27 insertions(+), 14 deletions(-) delete mode 100644 doc/user/getting-started.rst rename doc/user/{appendix.rst => packet-dumps.rst} (100%) diff --git a/doc/user/basic.rst b/doc/user/basic.rst index b5118cde4e..0c11975fc0 100644 --- a/doc/user/basic.rst +++ b/doc/user/basic.rst @@ -1,7 +1,7 @@ .. _basic-commands: ************** -Basic commands +Basic Commands ************** There are five routing daemons in use, and there is one manager daemon. diff --git a/doc/user/getting-started.rst b/doc/user/getting-started.rst deleted file mode 100644 index 4ef293c711..0000000000 --- a/doc/user/getting-started.rst +++ /dev/null @@ -1,9 +0,0 @@ -*************** -Getting Started -*************** - -.. toctree:: - :maxdepth: 2 - - installation - setup diff --git a/doc/user/index.rst b/doc/user/index.rst index 7118022df7..cec9c29230 100644 --- a/doc/user/index.rst +++ b/doc/user/index.rst @@ -1,11 +1,21 @@ +#################### FRRouting User Guide -==================== +#################### +.. _introduction: .. toctree:: + :caption: Introduction :maxdepth: 2 overview - getting-started + installation + setup + +.. _basics: +.. toctree:: + :caption: Basics + :maxdepth: 2 + basic vtysh filter @@ -13,6 +23,13 @@ FRRouting User Guide ipv6 kernel snmp +.. modules + +.. _protocols: +.. toctree:: + :caption: Protocols + :maxdepth: 2 + zebra bgp babeld @@ -27,7 +44,12 @@ FRRouting User Guide ripngd sharp vnc + +.. _appendix: +.. toctree:: + :caption: Appendix + :maxdepth: 2 + bugs + packet-dumps glossary - appendix - diff --git a/doc/user/appendix.rst b/doc/user/packet-dumps.rst similarity index 100% rename from doc/user/appendix.rst rename to doc/user/packet-dumps.rst -- 2.39.5