vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-12-17 19:12:41 +01:00
Code Issues Packages Projects Releases Wiki Activity

update sphinx and dependencies

Browse Source
This commit is contained in:
rebortg 2024-01-14 21:34:52 +01:00
parent a45a98349c
commit bcef0f76c5
4 changed files with 46 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@ -7,6 +7,7 @@ venv/
ENV/ ENV/
.venv .venv
Pipfile.lock Pipfile.lock
Pipfile
# put various editor ignores here # put various editor ignores here
.vscode/ .vscode/

2
docs/conf.py
View File

@ -47,7 +47,7 @@ extensions = ['sphinx.ext.intersphinx',
'notfound.extension', 'notfound.extension',
'autosectionlabel', 'autosectionlabel',
'myst_parser', 'myst_parser',
'sphinx_panels', 'sphinx_design',
'vyos' 'vyos'
] ]

40
docs/index.rst
View File

@ -4,45 +4,45 @@
VyOS User Guide VyOS User Guide
############### ###############
.. panels:: .. grid:: 3
:container: container-lg pb-3 :gutter: 2
:column: col-lg-4 col-md-4 col-sm-6 col-xs-12 p-2
.. grid-item-card:: Get / Build VyOS
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. 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
^^^^^^^^^^^^ .. grid-item-card:: Install VyOS
Read about how to install VyOS on :ref:`Bare Metal<installation/install:installation>` or in a 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 :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 how to use an image with the usual :ref:`cloud<installation/cloud/index:running VyOS in Cloud Environments>` providers
---
Configuration and Operation
^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. grid-item-card:: Configuration and Operation
Use the :ref:`Quickstart Guide<quick-start:Quick Start>`, to have a fast overview. Or go deeper and 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>`, set up :ref:`advanced routing<configuration/protocols/index:protocols>`,
:ref:`VRFs<configuration/vrf/index:vrf>`, or :ref:`VRFs<configuration/vrf/index:vrf>`, or
:ref:`VPNs<configuration/vpn/index:vpn>` for example. :ref:`VPNs<configuration/vpn/index:vpn>` for example.
---
Automate
^^^^^^^^ .. grid-item-card:: Automate
Integrate VyOS in your automation Workflow with Integrate VyOS in your automation Workflow with
:ref:`Ansible<vyos-ansible>`, :ref:`Ansible<vyos-ansible>`,
have your own :ref:`local scripts<command-scripting>`, or configure VyOS with the :ref:`HTTPS-API<vyosapi>`. have your own :ref:`local scripts<command-scripting>`, or configure VyOS with the :ref:`HTTPS-API<vyosapi>`.
---
Examples
^^^^^^^^ .. grid-item-card:: Examples
Get some inspiration from the :ref:`Configuration Blueprints<configexamples/index:Configuration Blueprints>` Get some inspiration from the :ref:`Configuration Blueprints<configexamples/index:Configuration Blueprints>`
to build your infrastructure. to build your infrastructure.
---
Contribute and Community
^^^^^^^^^^^^^^^^^^^^^^^^ .. grid-item-card:: Contribute and Community
| There are many ways to contribute to the project. | There are many ways to contribute to the project.
| Add missing parts or improve the :ref:`Documentation<documentation:Write Documentation>`. | 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>`_. | Discuss in `Slack <https://slack.vyos.io/>`_ or the `Forum <https://forum.vyos.io>`_.

14
requirements.txt
View File

@ -1,8 +1,8 @@
urllib3==1.26.15 urllib3==2.1.0
Sphinx==4.5.0 Sphinx==7.2.6
sphinx-rtd-theme==1.0.0 sphinx-rtd-theme==2.0.0
sphinx-autobuild==2021.3.14 sphinx-autobuild==2021.3.14
sphinx-notfound-page==0.8 sphinx-notfound-page==1.0.0
lxml==4.9.1 lxml==5.1.0
myst-parser==0.17.1 myst-parser==2.0.0
sphinx-panels==0.6.0 sphinx_design==0.5.0