diff options
| author | Quentin Young <qlyoung@cumulusnetworks.com> | 2018-06-06 20:17:59 +0000 |
|---|---|---|
| committer | Quentin Young <qlyoung@cumulusnetworks.com> | 2018-06-08 07:54:25 +0000 |
| commit | db910447b8b66d00f83eed83a08b86cc857c39bf (patch) | |
| tree | 0a655ac0b242967ece103e7f8f35ab7d28fe6333 | |
| parent | a22addd5a3860259802113a902e1feada7212d0f (diff) | |
doc: reorganize into multiple toctrees
Use multiple toctrees to reorganize the user docs into logical sections.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
| -rw-r--r-- | doc/user/basic.rst | 2 | ||||
| -rw-r--r-- | doc/user/getting-started.rst | 9 | ||||
| -rw-r--r-- | doc/user/index.rst | 30 | ||||
| -rw-r--r-- | doc/user/packet-dumps.rst (renamed from doc/user/appendix.rst) | 0 |
4 files changed, 27 insertions, 14 deletions
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 index 6120c3b989..6120c3b989 100644 --- a/doc/user/appendix.rst +++ b/doc/user/packet-dumps.rst |