diff options
| -rw-r--r-- | docs/_static/css/custom.css | 56 | ||||
| -rw-r--r-- | docs/_templates/layout.html | 4 | ||||
| -rw-r--r-- | docs/cli.rst (renamed from docs/ch02-cli.rst) | 2 | ||||
| -rw-r--r-- | docs/clustering.rst (renamed from docs/ch13-clustering.rst) | 2 | ||||
| -rw-r--r-- | docs/conf.py | 9 | ||||
| -rw-r--r-- | docs/configuration-overview.rst (renamed from docs/ch04-configuration-overview.rst) | 2 | ||||
| -rw-r--r-- | docs/examples.rst (renamed from docs/apxB-examples.rst) | 2 | ||||
| -rw-r--r-- | docs/firewall.rst (renamed from docs/ch07-firewall.rst) | 2 | ||||
| -rw-r--r-- | docs/image-mgmt.rst (renamed from docs/ch14-image-mgmt.rst) | 2 | ||||
| -rw-r--r-- | docs/index.rst | 68 | ||||
| -rw-r--r-- | docs/install.rst (renamed from docs/ch01-install.rst) | 2 | ||||
| -rw-r--r-- | docs/nat.rst (renamed from docs/ch08-nat.rst) | 2 | ||||
| -rw-r--r-- | docs/network-interfaces.rst (renamed from docs/ch05-network-interfaces.rst) | 2 | ||||
| -rw-r--r-- | docs/qos.rst (renamed from docs/ch10-qos.rst) | 2 | ||||
| -rw-r--r-- | docs/quick-start.rst (renamed from docs/ch03-quick-start.rst) | 2 | ||||
| -rw-r--r-- | docs/routing.rst (renamed from docs/ch06-routing.rst) | 2 | ||||
| -rw-r--r-- | docs/services.rst (renamed from docs/ch11-services.rst) | 2 | ||||
| -rw-r--r-- | docs/system.rst (renamed from docs/ch12-system.rst) | 2 | ||||
| -rw-r--r-- | docs/troubleshooting.rst (renamed from docs/apxA-troubleshooting.rst) | 2 | ||||
| -rw-r--r-- | docs/vpn.rst (renamed from docs/ch09-vpn.rst) | 2 | ||||
| -rw-r--r-- | requirements.txt | 3 |
21 files changed, 122 insertions, 50 deletions
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css new file mode 100644 index 00000000..a8b94c6e --- /dev/null +++ b/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; +} diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html new file mode 100644 index 00000000..387301ea --- /dev/null +++ b/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 %}
\ No newline at end of file diff --git a/docs/ch02-cli.rst b/docs/cli.rst index da93dcd8..66144fce 100644 --- a/docs/ch02-cli.rst +++ b/docs/cli.rst @@ -1,3 +1,5 @@ +.. _cli: + Command-Line Interface ====================== diff --git a/docs/ch13-clustering.rst b/docs/clustering.rst index 9f14c6ae..9eee31ea 100644 --- a/docs/ch13-clustering.rst +++ b/docs/clustering.rst @@ -1,3 +1,5 @@ +.. _clustering: + Clustering ========== diff --git a/docs/conf.py b/docs/conf.py index 05a92cff..e9960a8e 100644 --- a/docs/conf.py +++ b/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 diff --git a/docs/ch04-configuration-overview.rst b/docs/configuration-overview.rst index 54951364..3024c277 100644 --- a/docs/ch04-configuration-overview.rst +++ b/docs/configuration-overview.rst @@ -1,3 +1,5 @@ +.. _configuration-overview: + Configuration Overview ====================== diff --git a/docs/apxB-examples.rst b/docs/examples.rst index 8497316c..7194188a 100644 --- a/docs/apxB-examples.rst +++ b/docs/examples.rst @@ -1,3 +1,5 @@ +.. _examples: + Appendix B - Configuration Examples =================================== diff --git a/docs/ch07-firewall.rst b/docs/firewall.rst index 397c31ac..8ab4dacf 100644 --- a/docs/ch07-firewall.rst +++ b/docs/firewall.rst @@ -1,3 +1,5 @@ +.. _firewall: + Firewall ======== diff --git a/docs/ch14-image-mgmt.rst b/docs/image-mgmt.rst index a36ad112..ebb1de23 100644 --- a/docs/ch14-image-mgmt.rst +++ b/docs/image-mgmt.rst @@ -1,3 +1,5 @@ +.. _image-mgmt: + System Image Management ======================= 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` diff --git a/docs/ch01-install.rst b/docs/install.rst index b1896ef6..4714e87c 100644 --- a/docs/ch01-install.rst +++ b/docs/install.rst @@ -1,3 +1,5 @@ +.. _installation: + Installation ============ diff --git a/docs/ch08-nat.rst b/docs/nat.rst index d87f33de..a69cffbe 100644 --- a/docs/ch08-nat.rst +++ b/docs/nat.rst @@ -1,3 +1,5 @@ +.. _nat: + NAT === diff --git a/docs/ch05-network-interfaces.rst b/docs/network-interfaces.rst index 2e2a9ee5..e17d9dde 100644 --- a/docs/ch05-network-interfaces.rst +++ b/docs/network-interfaces.rst @@ -1,3 +1,5 @@ +.. _network-interfaces: + Network Interfaces ================== diff --git a/docs/ch10-qos.rst b/docs/qos.rst index 4be68662..d3ec2271 100644 --- a/docs/ch10-qos.rst +++ b/docs/qos.rst @@ -1,3 +1,5 @@ +.. _qos: + QoS and Traffic Policy ====================== diff --git a/docs/ch03-quick-start.rst b/docs/quick-start.rst index 3a4773b6..b4905f2a 100644 --- a/docs/ch03-quick-start.rst +++ b/docs/quick-start.rst @@ -1,3 +1,5 @@ +.. _quick-start: + Quick Start Guide ================= diff --git a/docs/ch06-routing.rst b/docs/routing.rst index 5efe6442..e570671d 100644 --- a/docs/ch06-routing.rst +++ b/docs/routing.rst @@ -1,3 +1,5 @@ +.. _routing: + Routing ======= diff --git a/docs/ch11-services.rst b/docs/services.rst index dce41acb..f66cc343 100644 --- a/docs/ch11-services.rst +++ b/docs/services.rst @@ -1,3 +1,5 @@ +.. _services: + Services ======== diff --git a/docs/ch12-system.rst b/docs/system.rst index e613bfac..445d9248 100644 --- a/docs/ch12-system.rst +++ b/docs/system.rst @@ -1,3 +1,5 @@ +.. _system: + System ====== diff --git a/docs/apxA-troubleshooting.rst b/docs/troubleshooting.rst index 917dc1b7..09877df3 100644 --- a/docs/apxA-troubleshooting.rst +++ b/docs/troubleshooting.rst @@ -1,3 +1,5 @@ +.. _troubleshooting: + Appendix A - Troubleshooting ============================ diff --git a/docs/ch09-vpn.rst b/docs/vpn.rst index 142bdc8b..28cacc69 100644 --- a/docs/ch09-vpn.rst +++ b/docs/vpn.rst @@ -1,3 +1,5 @@ +.. _vpn: + VPN === diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..0def141f --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +Sphinx>=1.4.3 +sphinx-rtd-theme +setuptools |