diff options
| -rw-r--r-- | Pipfile | 1 | ||||
| -rw-r--r-- | docker/Dockerfile | 1 | ||||
| -rw-r--r-- | docs/_static/css/custom.css | 5 | ||||
| -rw-r--r-- | docs/conf.py | 1 | ||||
| -rw-r--r-- | docs/index.rst | 54 | ||||
| -rw-r--r-- | requirements.txt | 74 |
6 files changed, 124 insertions, 12 deletions
@@ -9,6 +9,7 @@ docutils = "*" lxml = "*" sphinx-notfound-page = "*" Sphinx = ">=1.4.3" +sphinx-panels = "*" [dev-packages] diff --git a/docker/Dockerfile b/docker/Dockerfile index fbb60ddc..9b3195df 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -35,6 +35,7 @@ RUN pip3 install sphinx-autobuild RUN pip3 install sphinx-notfound-page RUN pip3 install lxml RUN pip3 install myst-parser +RUN pip3 install sphinx-panels # Cleanup diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css index d857abd6..5b673f18 100644 --- a/docs/_static/css/custom.css +++ b/docs/_static/css/custom.css @@ -1,3 +1,8 @@ +div.card-header { + font-weight: bold; + background: #fdab10; +} + span.opcmd, span.cfgcmd { font-weight: bold; diff --git a/docs/conf.py b/docs/conf.py index e21b2a1e..b86c869c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -47,6 +47,7 @@ extensions = ['sphinx.ext.intersphinx', 'notfound.extension', 'autosectionlabel', 'myst_parser', + 'sphinx_panels', 'vyos' ] diff --git a/docs/index.rst b/docs/index.rst index f4c562d1..2b775833 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,7 +4,53 @@ VyOS User Guide ############### +.. panels:: + :container: container-lg pb-3 + :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2 + + Get / Build VyOS + ^^^^^^^^^^^^^^^^ + Quickly :ref:`Build<contributing/build-vyos:build vyos>` your own Image or take a look at how to :ref:`download<installation/install:download>` a free or supported version. + --- + + Install VyOS + ^^^^^^^^^^^^ + Read about how to install VyOS on :ref:`Bare Metall<installation/install:installation>` or in a + :ref:`Virtual Environment<installation/virtual/index:running vyos in virtual environments>` and + how to use an image with the usual :ref:`cloud<installation/cloud/index:running VyOS in Cloud Environments>` providers + --- + + Configuration and Operation + ^^^^^^^^^^^^^^^^^^^^^^^^^^^ + Use the :ref:`Quickstart Guide<quick-start:Quick Start>`, to have a fast overview. Or go deeper and + set up :ref:`advanced routing<configuration/protocols/index:protocols>`, + :ref:`VRFs<configuration/vrf/index:vrf>`, or + :ref:`VPNs<configuration/vpn/index:vpn>` for example. + --- + + Automate + ^^^^^^^^ + Integrate VyOS in your automation Workflow with + :ref:`Ansible<vyos-ansible>`, + have your own :ref:`local scripts<command-scripting>`, or configure VyOS with the :ref:`HTTPS-API<vyosapi>`. + --- + + Examples + ^^^^^^^^ + Get some inspiration from the :ref:`Configuration Blueprints<configexamples/index:Configuration Blueprints>` + to build your infrastructure. + --- + + Contribute and Community + ^^^^^^^^^^^^^^^^^^^^^^^^ + | There are many ways to contribute to the project. + | Add missing parts or improve the :ref:`Documentation<documentation:Write Documentation>`. + | Discuss in `Slack <https://slack.vyos.io/>`_ or the `Forum <https://forum.vyos.io>`_. + | Or you can pick up a `Task <https://phabricator.vyos.net/>`_ and fix the :ref:`code<contributing/development:development>`. + + .. toctree:: + :hidden: :maxdepth: 1 introducing/about @@ -14,7 +60,7 @@ VyOS User Guide .. toctree:: :maxdepth: 2 - :includehidden: + :hidden: :caption: First Steps installation/index @@ -23,7 +69,7 @@ VyOS User Guide .. toctree:: :maxdepth: 2 - :includehidden: + :hidden: :caption: Adminguide @@ -36,7 +82,7 @@ VyOS User Guide .. toctree:: :maxdepth: 2 - :includehidden: + :hidden: :caption: Development contributing/build-vyos @@ -49,7 +95,7 @@ VyOS User Guide .. toctree:: :maxdepth: 2 - :includehidden: + :hidden: :caption: Misc documentation diff --git a/requirements.txt b/requirements.txt index 8b5ba40f..ed57d37c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,66 @@ -Sphinx>=1.4.3 -sphinx-rtd-theme -setuptools -docutils -lxml -sphinx-notfound-page -docutils<0.18 -myst-parser +alabaster==0.7.12 +attrs==21.4.0 +Babel==2.9.1 +certifi==2021.10.8 +chardet==3.0.4 +charset-normalizer==2.0.12 +click==7.1.2 +decorator==4.4.2 +dnspython==1.16.0 +docopt==0.6.2 +docutils==0.17.1 +fett==0.3.2 +idna==3.3 +imagesize==1.3.0 +importlib-metadata==4.11.3 +Jinja2==3.1.1 +lxml==4.8.0 +markdown-it-py==2.0.1 +MarkupSafe==2.1.1 +mdformat==0.7.13 +mdformat-deflist==0.1.1 +mdformat-frontmatter==0.4.1 +mdformat-myst==0.1.5 +mdformat-tables==0.4.1 +mdit-py-plugins==0.3.0 +mdurl==0.1.0 +myst-parser==0.17.0 +networkx==2.5 +packaging==21.3 +pandoc==2.1 +pathtools==0.1.2 +phabricator==0.8.0 +plumbum==1.7.2 +ply==3.11 +Pygments==2.11.2 +pymongo==3.11.2 +pyparsing==3.0.7 +python-jsonrpc-server==0.3.4 +pytz==2022.1 +PyYAML==6.0 +requests==2.27.1 +rst-to-myst==0.3.2 +rstcheck==3.3.1 +ruamel.yaml==0.17.21 +ruamel.yaml.clib==0.2.6 +six==1.15.0 +snooty-lextudio==1.8.6.dev0 +snowballstemmer==2.2.0 +Sphinx==4.5.0 +sphinx-notfound-page==0.8 +sphinx-panels==0.6.0 +sphinx-rtd-theme==1.0.0 +sphinx-sitemap==2.2.0 +sphinxcontrib-applehelp==1.0.2 +sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-htmlhelp==2.0.0 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-qthelp==1.0.3 +sphinxcontrib-serializinghtml==1.1.5 +toml==0.10.2 +tomli==2.0.1 +typing-extensions==4.1.1 +ujson==1.35 +urllib3==1.26.9 +watchdog==0.10.4 +zipp==3.7.0 |