doc: reorganize into multiple toctrees

Use multiple toctrees to reorganize the user docs into logical sections.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
This commit is contained in:
Quentin Young 2018-06-06 20:17:59 +00:00
parent a22addd5a3
commit db910447b8
4 changed files with 28 additions and 15 deletions

View File

@ -1,7 +1,7 @@
.. _basic-commands: .. _basic-commands:
************** **************
Basic commands Basic Commands
************** **************
There are five routing daemons in use, and there is one manager daemon. There are five routing daemons in use, and there is one manager daemon.

View File

@ -1,9 +0,0 @@
***************
Getting Started
***************
.. toctree::
:maxdepth: 2
installation
setup

View File

@ -1,11 +1,21 @@
####################
FRRouting User Guide FRRouting User Guide
==================== ####################
.. _introduction:
.. toctree:: .. toctree::
:caption: Introduction
:maxdepth: 2 :maxdepth: 2
overview overview
getting-started installation
setup
.. _basics:
.. toctree::
:caption: Basics
:maxdepth: 2
basic basic
vtysh vtysh
filter filter
@ -13,6 +23,13 @@ FRRouting User Guide
ipv6 ipv6
kernel kernel
snmp snmp
.. modules
.. _protocols:
.. toctree::
:caption: Protocols
:maxdepth: 2
zebra zebra
bgp bgp
babeld babeld
@ -27,7 +44,12 @@ FRRouting User Guide
ripngd ripngd
sharp sharp
vnc vnc
bugs
glossary
appendix
.. _appendix:
.. toctree::
:caption: Appendix
:maxdepth: 2
bugs
packet-dumps
glossary