diff options
| author | rebortg <github@ghlr.de> | 2024-01-13 23:11:49 +0100 | 
|---|---|---|
| committer | rebortg <github@ghlr.de> | 2024-01-13 23:12:06 +0100 | 
| commit | 0740593f13225ad72a127e99aaa49d5a32ba5325 (patch) | |
| tree | c4fc71dd27f2fc338c6a01db789b141828f47dd5 | |
| parent | d4d3efe7fb4c0a86c6d33a9664eb18fb22e4205e (diff) | |
| download | vyos-documentation-0740593f13225ad72a127e99aaa49d5a32ba5325.tar.gz vyos-documentation-0740593f13225ad72a127e99aaa49d5a32ba5325.zip  | |
update sphinx and dependencies
| -rw-r--r-- | Pipfile | 18 | ||||
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/index.rst | 86 | ||||
| -rw-r--r-- | requirements.txt | 14 | 
4 files changed, 52 insertions, 68 deletions
diff --git a/Pipfile b/Pipfile deleted file mode 100644 index 0d7f836f..00000000 --- a/Pipfile +++ /dev/null @@ -1,18 +0,0 @@ -[[source]] -url = "https://pypi.org/simple" -verify_ssl = true -name = "pypi" - -[packages] -sphinx-rtd-theme = "*" -docutils = "*" -lxml = "*" -sphinx-notfound-page = "*" -Sphinx = ">=1.4.3" -sphinx-panels = "*" -transifex-client = "*" - -[dev-packages] - -[requires] -python_version = "3.9" diff --git a/docs/conf.py b/docs/conf.py index 3fe1c6e1..4414286d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -47,7 +47,7 @@ extensions = ['sphinx.ext.intersphinx',                'notfound.extension',                'autosectionlabel',                'myst_parser', -              'sphinx_panels', +              'sphinx_design',                'vyos'  ] diff --git a/docs/index.rst b/docs/index.rst index c1ac38ed..4db014a9 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -4,49 +4,51 @@  VyOS User Guide  ############### -.. panels:: -   :container: container-lg pb-3 -   :column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2 + + +.. grid:: 3 +   :gutter: 2 +    +   .. grid-item-card:: 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. -   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 Metal<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://vyos.dev/>`_ and fix the :ref:`code<contributing/development:development>`. + +   .. grid-item-card:: Install VyOS + +      Read about how to install VyOS on :ref:`Bare Metal<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  +    + +   .. grid-item-card:: 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. +    + +   .. grid-item-card:: 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>`. +    + +   .. grid-item-card::  Examples + +      Get some inspiration from the :ref:`Configuration Blueprints<configexamples/index:Configuration Blueprints>` +      to build your infrastructure. +    + +   .. grid-item-card:: 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://vyos.dev/>`_ and fix the :ref:`code<contributing/development:development>`.  .. toctree:: diff --git a/requirements.txt b/requirements.txt index 9ca1cac2..08a1fd15 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,8 @@ -urllib3==1.26.18 -Sphinx==4.5.0 -sphinx-rtd-theme==1.0.0 +urllib3==2.1.0 +Sphinx==7.2.6 +sphinx-rtd-theme==2.0.0  sphinx-autobuild==2021.3.14 -sphinx-notfound-page==0.8 -lxml==4.9.1 -myst-parser==0.17.1 -sphinx-panels==0.6.0 +sphinx-notfound-page==1.0.0 +lxml==5.1.0 +myst-parser==2.0.0 +sphinx_design==0.5.0
\ No newline at end of file  | 
