vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-12-16 10:32:02 +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/
.venv
Pipfile.lock
Pipfile
# put various editor ignores here
.vscode/

2
docs/conf.py
View File

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

74
docs/index.rst
View File

@ -4,49 +4,49 @@
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
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:: Get / Build VyOS
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
---
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.
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:: Install VyOS
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>`.
---
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
Examples
^^^^^^^^
Get some inspiration from the :ref:`Configuration Blueprints<configexamples/index:Configuration Blueprints>`
to build your infrastructure.
---
.. grid-item-card:: Configuration and Operation
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>`.
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::

14
requirements.txt
View File

@ -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