mirror of
https://github.com/vyos/vyos-documentation.git
synced 2025-10-26 08:41:46 +01:00
update sphinx and dependencies
This commit is contained in:
rebortg
parent
d4d3efe7fb
commit
0740593f13
18
Pipfile
18
Pipfile
@ -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"
|
|
||||||
@ -47,7 +47,7 @@ extensions = ['sphinx.ext.intersphinx',
|
|||||||
'notfound.extension',
|
'notfound.extension',
|
||||||
'autosectionlabel',
|
'autosectionlabel',
|
||||||
'myst_parser',
|
'myst_parser',
|
||||||
'sphinx_panels',
|
'sphinx_design',
|
||||||
'vyos'
|
'vyos'
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|||||||
@ -4,49 +4,51 @@
|
|||||||
VyOS User Guide
|
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
|
.. 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.
|
|
||||||
---
|
|
||||||
|
|
||||||
Install 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.
|
||||||
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
|
.. grid-item-card:: Install VyOS
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
|
||||||
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
|
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
|
||||||
Integrate VyOS in your automation Workflow with
|
how to use an image with the usual :ref:`cloud<installation/cloud/index:running VyOS in Cloud Environments>` providers
|
||||||
:ref:`Ansible<vyos-ansible>`,
|
|
||||||
have your own :ref:`local scripts<command-scripting>`, or configure VyOS with the :ref:`HTTPS-API<vyosapi>`.
|
|
||||||
---
|
|
||||||
|
|
||||||
Examples
|
.. grid-item-card:: Configuration and Operation
|
||||||
^^^^^^^^
|
|
||||||
Get some inspiration from the :ref:`Configuration Blueprints<configexamples/index:Configuration Blueprints>`
|
|
||||||
to build your infrastructure.
|
|
||||||
---
|
|
||||||
|
|
||||||
Contribute and Community
|
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>`,
|
||||||
| There are many ways to contribute to the project.
|
:ref:`VRFs<configuration/vrf/index:vrf>`, or
|
||||||
| Add missing parts or improve the :ref:`Documentation<documentation:Write Documentation>`.
|
:ref:`VPNs<configuration/vpn/index:vpn>` for example.
|
||||||
| 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:: 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::
|
.. toctree::
|
||||||
|
|||||||
@ -1,8 +1,8 @@
|
|||||||
urllib3==1.26.18
|
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
|
||||||
Loading…
x
Reference in New Issue
Block a user