Reformat TOC and overall document style

docs/_static/css/custom.css

@@ -0,0 +1,56 @@
+.wy-nav-content {
+  max-width : none;
+}
+
+.wy-tray-container li.wy-tray-item-info {
+  background : #409ad5;
+}
+
+.wy-table-responsive {
+  overflow : visible !important;
+}
+
+.wy-table-responsive table td {
+  white-space : normal !important;
+}
+
+.wy-menu-vertical header,
+.wy-menu-vertical p.caption {
+  color : #ffcc00 !important;
+}
+
+.wy-menu-vertical li.current a {
+  color : #040077 !important;
+}
+
+.wy-menu-vertical li ul li a {
+  color : #ffffff !important;
+}
+
+.wy-menu-vertical a {
+  color : #ffffff !important;
+}
+
+.wy-menu-vertical a:active {
+  background-color : #409ad5 !important;
+}
+
+.wy-side-nav-search {
+  background-color : #FF0000 !important;
+}
+
+.wy-side-nav-search img {
+  background-color : #FF0000 !important;
+}
+
+.wy-side-nav-search > div.version {
+  color : rgba(255, 255, 255, 0.7) !important;
+}
+
+.wy-nav-top {
+  background-color : #FF0000 !important;
+}
+
+.wy-nav-top img {
+  background-color : #FF0000 !important;
+}

docs/_templates/layout.html

@@ -0,0 +1,4 @@
+{% extends "!layout.html" %}
+{% block extrahead %}
+    <link href="{{ pathto("_static/css/custom.css", True) }}" rel="stylesheet" type="text/css">
+{% endblock %}

docs/cli.rst

@@ -1,3 +1,5 @@
+.. _cli:
+
 Command-Line Interface
 ======================
 

docs/clustering.rst

@@ -1,3 +1,5 @@
+.. _clustering:
+
 Clustering
 ==========
 

docs/conf.py

@@ -39,8 +39,9 @@ release = u'1.2.0-beta'
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
+extensions = ['sphinx.ext.intersphinx',
-]
+              'sphinx.ext.todo',
+              'sphinx.ext.ifconfig']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -69,13 +70,15 @@ exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store']
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'default'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/configuration-overview.rst

@@ -1,3 +1,5 @@
+.. _configuration-overview:
+
 Configuration Overview
 ======================
 

docs/examples.rst

@@ -1,3 +1,5 @@
+.. _examples:
+
 Appendix B - Configuration Examples
 ===================================
 

docs/firewall.rst

@@ -1,3 +1,5 @@
+.. _firewall:
+
 Firewall
 ========
 

docs/image-mgmt.rst

@@ -1,3 +1,5 @@
+.. _image-mgmt:
+
 System Image Management
 =======================
 

docs/index.rst

@@ -1,17 +1,8 @@
-.. VyOS documentation master file, created by
+.. _index:
-   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.
 
 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
+.. toctree::
+    :maxdepth: 3
+    :caption: Contents:
 
-.. include:: ch02-cli.rst
+    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
 
-.. 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
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/install.rst

@@ -1,3 +1,5 @@
+.. _installation:
+
 Installation
 ============
 

docs/nat.rst

@@ -1,3 +1,5 @@
+.. _nat:
+
 NAT
 ===
 

docs/network-interfaces.rst

@@ -1,3 +1,5 @@
+.. _network-interfaces:
+
 Network Interfaces
 ==================
 

docs/qos.rst

@@ -1,3 +1,5 @@
+.. _qos:
+
 QoS and Traffic Policy
 ======================
 

docs/quick-start.rst

@@ -1,3 +1,5 @@
+.. _quick-start:
+
 Quick Start Guide
 =================
 

docs/routing.rst

@@ -1,3 +1,5 @@
+.. _routing:
+
 Routing
 =======
 

docs/services.rst

@@ -1,3 +1,5 @@
+.. _services:
+
 Services
 ========
 

docs/system.rst

@@ -1,3 +1,5 @@
+.. _system:
+
 System
 ======
 

docs/troubleshooting.rst

@@ -1,3 +1,5 @@
+.. _troubleshooting:
+
 Appendix A - Troubleshooting
 ============================
 

docs/vpn.rst

@@ -1,3 +1,5 @@
+.. _vpn:
+
 VPN
 ===
 

requirements.txt

@@ -0,0 +1,3 @@
+Sphinx>=1.4.3
+sphinx-rtd-theme
+setuptools