summaryrefslogtreecommitdiff
path: root/docs/index.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2018-10-07 14:39:58 +0200
committerChristian Poessinger <christian@poessinger.com>2018-10-07 14:39:58 +0200
commite175b066d4701be34352db2a17cd31e4195d4af9 (patch)
treea06520cbf67e918b55284ee02db8115c99da926c /docs/index.rst
parent0a0e52b63842dde0aab71583b2eb459b3de79ec9 (diff)
downloadvyos-documentation-e175b066d4701be34352db2a17cd31e4195d4af9.tar.gz
vyos-documentation-e175b066d4701be34352db2a17cd31e4195d4af9.zip
Reformat TOC and overall document style
Diffstat (limited to 'docs/index.rst')
-rw-r--r--docs/index.rst68
1 files changed, 21 insertions, 47 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 4b3c4a13..39c9985f 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,17 +1,8 @@
-.. VyOS documentation master file, created by
- sphinx-quickstart on Sun Jul 1 14:35:07 2018.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
+.. _index:
Welcome to VyOS's documentation!
================================
-.. toctree::
- :maxdepth: 2
- :caption: Contents:
-
-Introduction
-============
VyOS is an open source network operating system based on Debian GNU/Linux.
VyOS provides a free routing platform that competes directly with other
@@ -19,41 +10,24 @@ commercially available solutions from well known network providers. Because
VyOS is run on standard amd64, i586 and ARM systems, it is able to be used
as a router and firewall platform for cloud deployments.
-.. include:: ch01-install.rst
-
-.. include:: ch02-cli.rst
-
-.. include:: ch03-quick-start.rst
-
-.. include:: ch04-configuration-overview.rst
-
-.. include:: ch05-network-interfaces.rst
-
-.. include:: ch06-routing.rst
-
-.. include:: ch07-firewall.rst
-
-.. include:: ch08-nat.rst
-
-.. include:: ch09-vpn.rst
-
-.. include:: ch10-qos.rst
-
-.. include:: ch11-services.rst
-
-.. include:: ch12-system.rst
-
-.. include:: ch13-clustering.rst
-
-.. include:: ch14-image-mgmt.rst
-
-.. include:: apxA-troubleshooting.rst
-
-.. include:: apxB-examples.rst
-
-Indices and tables
-==================
+.. toctree::
+ :maxdepth: 3
+ :caption: Contents:
+
+ install.rst
+ cli.rst
+ quick-start.rst
+ configuration-overview.rst
+ network-interfaces.rst
+ routing.rst
+ firewall.rst
+ nat.rst
+ vpn.rst
+ qos.rst
+ services
+ system.rst
+ clustering.rst
+ image-mgmt.rst
+ troubleshooting.rst
+ examples.rst
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`