summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorrebortg <github@ghlr.de>2024-01-14 21:34:52 +0100
committerrebortg <github@ghlr.de>2024-01-14 21:37:48 +0100
commitf4d7a546d49c909dafc416a829f96b590ce5fb14 (patch)
treed675a6f268ad02fd9e0839e2e2ec8b075c9b5b5a
parent67f7a270b3cc6bb687cc75685b0e56d4eece3613 (diff)
downloadvyos-documentation-f4d7a546d49c909dafc416a829f96b590ce5fb14.tar.gz
vyos-documentation-f4d7a546d49c909dafc416a829f96b590ce5fb14.zip
update sphinx and dependencies
(cherry picked from commit bcef0f76c56dc715aaa05fe21943f013619827af)
-rw-r--r--.gitignore7
-rw-r--r--docs/conf.py2
-rw-r--r--docs/index.rst87
-rw-r--r--requirements.txt14
4 files changed, 58 insertions, 52 deletions
diff --git a/.gitignore b/.gitignore
index 81d49b98..f1efd54e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,11 +1,13 @@
# Sphinx
_build/
+localazy_private.json
# python virtualenv
venv/
ENV/
.venv
Pipfile.lock
+Pipfile
# put various editor ignores here
.vscode/
@@ -13,6 +15,9 @@ Pipfile.lock
*.vpw
*.vpwhist
*.vtg
+.idea/
+.idea
+.idea/*
# python cache files
*.pyc
@@ -23,4 +28,4 @@ __pycache__
.envrc
# os specific
-.DS_Store
+.DS_Store \ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
index ebd8ef86..d3ba6fd5 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -46,7 +46,7 @@ extensions = ['sphinx.ext.intersphinx',
'sphinx.ext.graphviz',
'notfound.extension',
'myst_parser',
- 'sphinx_panels',
+ 'sphinx_design',
'vyos'
]
diff --git a/docs/index.rst b/docs/index.rst
index db0b0172..9b36f9af 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -4,49 +4,50 @@
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<build>` your own Image or take a look at how to :ref:`download<download>` a free or supported version.
- ---
-
- Install VyOS
- ^^^^^^^^^^^^
- Read about how to install VyOS on :ref:`Bare Metall<installation>` or in a
- :ref:`Virtual Environment<virtual_env>` and
- how to use an image with the usual :ref:`cloud<cloud_env>` providers
- ---
-
- Configuration and Operation
- ^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Use the :ref:`Quickstart Guide<quick-start>`, to have a fast overview. Or go deeper and
- set up :ref:`advanced routing<protocols>`,
- :ref:`VRFs<vrf>`, or
- :ref:`VPNs<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<examples>`
- 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>`.
- | 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<development>`.
+.. 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.
+
+
+ .. 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::
:hidden:
diff --git a/requirements.txt b/requirements.txt
index 50126c4c..0a846a72 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -1,8 +1,8 @@
-urllib3==1.26.15
-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