change include to absolute path

This commit is contained in:
rebortg 2020-11-30 19:46:59 +01:00
parent ad0dc9cf1a
commit e33e1268f9
39 changed files with 97 additions and 126 deletions

View File

@ -3,7 +3,7 @@ import json
import os
from docutils import io, nodes, utils, statemachine
from docutils.parsers.rst.roles import set_classes
from docutils.parsers.rst import Directive, directives
from docutils.parsers.rst import Directive, directives, states
from sphinx.util.docutils import SphinxDirective
@ -173,7 +173,7 @@ class inlinecmd(nodes.inline):
#self.literal_whitespace -= 1
class CfgInclude(Directive):
class CfgInclude(SphinxDirective):
required_arguments = 1
optional_arguments = 0
final_argument_whitespace = True
@ -189,10 +189,15 @@ class CfgInclude(Directive):
'var8': str,
'var9': str
}
standard_include_path = os.path.join(os.path.dirname(states.__file__),
'include')
def run(self):
### Copy from include directive docutils
"""Include a file as part of the content of this reST file."""
rel_filename, filename = self.env.relfn2path(self.arguments[0])
self.arguments[0] = filename
self.env.note_included(filename)
if not self.state.document.settings.file_insertion_enabled:
raise self.warning('"%s" directive disabled.' % self.name)
source = self.state_machine.input_lines.source(

View File

@ -1,17 +1,17 @@
.. cmdinclude:: ../_include/interface-address-with-dhcp.txt
.. cmdinclude:: /_include/interface-address-with-dhcp.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
.. cmdinclude:: ../_include/interface-common.txt
.. cmdinclude:: /_include/interface-common.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
**DHCP(v6)**
.. cmdinclude:: ../_include/interface-dhcp-options.txt
.. cmdinclude:: /_include/interface-dhcp-options.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
.. cmdinclude:: ../_include/interface-dhcpv6-options.txt
.. cmdinclude:: /_include/interface-dhcpv6-options.txt
:var0: {{ var0 }}
:var1: {{ var1 }}

View File

@ -1,7 +1,7 @@
.. cmdinclude:: ../_include/interface-address.txt
.. cmdinclude:: /_include/interface-address.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
.. cmdinclude:: ../_include/interface-common.txt
.. cmdinclude:: /_include/interface-common.txt
:var0: {{ var0 }}
:var1: {{ var1 }}

View File

@ -1,36 +1,36 @@
.. cmdinclude:: ../_include/interface-description.txt
.. cmdinclude:: /_include/interface-description.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
.. cmdinclude:: ../_include/interface-disable.txt
.. cmdinclude:: /_include/interface-disable.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
.. cmdinclude:: ../_include/interface-disable-flow-control.txt
.. cmdinclude:: /_include/interface-disable-flow-control.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
.. cmdinclude:: ../_include/interface-disable-link-detect.txt
.. cmdinclude:: /_include/interface-disable-link-detect.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
.. cmdinclude:: ../_include/interface-mac.txt
.. cmdinclude:: /_include/interface-mac.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
.. cmdinclude:: ../_include/interface-mtu.txt
.. cmdinclude:: /_include/interface-mtu.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
.. cmdinclude:: ../_include/interface-ipv6-addr-autoconf.txt
.. cmdinclude:: /_include/interface-ipv6-addr-autoconf.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
.. cmdinclude:: ../_include/interface-ipv6-addr-eui64.txt
.. cmdinclude:: /_include/interface-ipv6-addr-eui64.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
.. cmdinclude:: ../_include/interface-vrf.txt
.. cmdinclude:: /_include/interface-vrf.txt
:var0: {{ var0 }}
:var1: {{ var1 }}

View File

@ -30,7 +30,7 @@
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6-options temporary
.. cmdinclude:: ../_include/interface-dhcpv6-prefix-delegation.txt
.. cmdinclude:: /_include/interface-dhcpv6-prefix-delegation.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: {{ var2 }}

View File

@ -1,4 +1,4 @@
.. include:: ../_include/need_improvement.txt
.. include:: /_include/need_improvement.txt
IEEE 802.1ad_ was an Ethernet networking standard informally known as QinQ as
an amendment to IEEE standard 802.1q VLAN interfaces as described above.
@ -28,7 +28,7 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
(service tag with Ethernet Type = 0x88a8).
.. cmdinclude:: ../_include/interface-address-with-dhcp.txt
.. cmdinclude:: /_include/interface-address-with-dhcp.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif-s
@ -38,7 +38,7 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
:var6: <vlan-id>
:var7: 20
.. cmdinclude:: ../_include/interface-description.txt
.. cmdinclude:: /_include/interface-description.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif-s
@ -48,7 +48,7 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
:var6: <vlan-id>
:var7: 20
.. cmdinclude:: ../_include/interface-disable.txt
.. cmdinclude:: /_include/interface-disable.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif-s
@ -58,7 +58,7 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
:var6: <vlan-id>
:var7: 20
.. cmdinclude:: ../_include/interface-disable-link-detect.txt
.. cmdinclude:: /_include/interface-disable-link-detect.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif-s
@ -68,7 +68,7 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
:var6: <vlan-id>
:var7: 20
.. cmdinclude:: ../_include/interface-mac.txt
.. cmdinclude:: /_include/interface-mac.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif-s
@ -78,7 +78,7 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
:var6: <vlan-id>
:var7: 20
.. cmdinclude:: ../_include/interface-mtu.txt
.. cmdinclude:: /_include/interface-mtu.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif-s
@ -88,7 +88,7 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
:var6: <vlan-id>
:var7: 20
.. cmdinclude:: ../_include/interface-ipv6-addr-autoconf.txt
.. cmdinclude:: /_include/interface-ipv6-addr-autoconf.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif-s
@ -98,7 +98,7 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
:var6: <vlan-id>
:var7: 20
.. cmdinclude:: ../_include/interface-ipv6-addr-eui64.txt
.. cmdinclude:: /_include/interface-ipv6-addr-eui64.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif-s
@ -108,7 +108,7 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
:var6: <vlan-id>
:var7: 20
.. cmdinclude:: ../_include/interface-vrf.txt
.. cmdinclude:: /_include/interface-vrf.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif-s
@ -120,7 +120,7 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
**DHCP(v6)**
.. cmdinclude:: ../_include/interface-dhcp-options.txt
.. cmdinclude:: /_include/interface-dhcp-options.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif-s
@ -130,7 +130,7 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
:var6: <vlan-id>
:var7: 20
.. cmdinclude:: ../_include/interface-dhcpv6-options.txt
.. cmdinclude:: /_include/interface-dhcpv6-options.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif-s
@ -140,4 +140,4 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG
:var6: <vlan-id>
:var7: 20
.. include:: ../common-references.rst
.. include:: /common-references.rst

View File

@ -29,63 +29,63 @@ term used for this is ``vif``.
.. note:: Only 802.1Q-tagged packets are accepted on Ethernet vifs.
.. cmdinclude:: ../_include/interface-address-with-dhcp.txt
.. cmdinclude:: /_include/interface-address-with-dhcp.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif
:var3: <vlan-id>
:var4: 10
.. cmdinclude:: ../_include/interface-description.txt
.. cmdinclude:: /_include/interface-description.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif
:var3: <vlan-id>
:var4: 10
.. cmdinclude:: ../_include/interface-disable.txt
.. cmdinclude:: /_include/interface-disable.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif
:var3: <vlan-id>
:var4: 10
.. cmdinclude:: ../_include/interface-disable-link-detect.txt
.. cmdinclude:: /_include/interface-disable-link-detect.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif
:var3: <vlan-id>
:var4: 10
.. cmdinclude:: ../_include/interface-mac.txt
.. cmdinclude:: /_include/interface-mac.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif
:var3: <vlan-id>
:var4: 10
.. cmdinclude:: ../_include/interface-mtu.txt
.. cmdinclude:: /_include/interface-mtu.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif
:var3: <vlan-id>
:var4: 10
.. cmdinclude:: ../_include/interface-ipv6-addr-autoconf.txt
.. cmdinclude:: /_include/interface-ipv6-addr-autoconf.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif
:var3: <vlan-id>
:var4: 10
.. cmdinclude:: ../_include/interface-ipv6-addr-eui64.txt
.. cmdinclude:: /_include/interface-ipv6-addr-eui64.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif
:var3: <vlan-id>
:var4: 10
.. cmdinclude:: ../_include/interface-vrf.txt
.. cmdinclude:: /_include/interface-vrf.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif
@ -94,18 +94,18 @@ term used for this is ``vif``.
**DHCP(v6)**
.. cmdinclude:: ../_include/interface-dhcp-options.txt
.. cmdinclude:: /_include/interface-dhcp-options.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif
:var3: <vlan-id>
:var4: 10
.. cmdinclude:: ../_include/interface-dhcpv6-options.txt
.. cmdinclude:: /_include/interface-dhcpv6-options.txt
:var0: {{ var0 }}
:var1: {{ var1 }}
:var2: vif
:var3: <vlan-id>
:var4: 10
.. include:: ../common-references.rst
.. include:: /common-references.rst

View File

@ -3,6 +3,7 @@
Firewall
========
Overview
--------

View File

@ -17,7 +17,7 @@ Configuration
Common interface configuration
==============================
.. cmdinclude:: ../_include/interface-common-with-dhcp.txt
.. cmdinclude:: /_include/interface-common-with-dhcp.txt
:var0: bond
:var1: bond0
@ -259,7 +259,7 @@ Bond options
VLAN
====
.. cmdinclude:: ../_include/interface-vlan-8021q.txt
.. cmdinclude:: /_include/interface-vlan-8021q.txt
:var0: bond
:var1: bond0

View File

@ -21,7 +21,7 @@ Configuration
Common interface configuration
==============================
.. cmdinclude:: ../_include/interface-common-with-dhcp.txt
.. cmdinclude:: /_include/interface-common-with-dhcp.txt
:var0: bridge
:var1: br0
@ -116,7 +116,7 @@ links providing fault tolerance if an active link fails.
VLAN
====
.. cmdinclude:: ../_include/interface-vlan-8021q.txt
.. cmdinclude:: /_include/interface-vlan-8021q.txt
:var0: bridge
:var1: br0

View File

@ -25,19 +25,19 @@ Configuration
Common interface configuration
==============================
.. cmdinclude:: ../_include/interface-address.txt
.. cmdinclude:: /_include/interface-address.txt
:var0: dummy
:var1: dum0
.. cmdinclude:: ../_include/interface-description.txt
.. cmdinclude:: /_include/interface-description.txt
:var0: dummy
:var1: dum0
.. cmdinclude:: ../_include/interface-disable.txt
.. cmdinclude:: /_include/interface-disable.txt
:var0: dummy
:var1: dum0
.. cmdinclude:: ../_include/interface-vrf.txt
.. cmdinclude:: /_include/interface-vrf.txt
:var0: dummy
:var1: dum0

View File

@ -14,7 +14,7 @@ Configuration
Common interface configuration
==============================
.. cmdinclude:: ../_include/interface-common-with-dhcp.txt
.. cmdinclude:: /_include/interface-common-with-dhcp.txt
:var0: ethernet
:var1: eth0
@ -72,14 +72,14 @@ VLAN
Regular VLANs (802.1q)
----------------------
.. cmdinclude:: ../_include/interface-vlan-8021q.txt
.. cmdinclude:: /_include/interface-vlan-8021q.txt
:var0: ethernet
:var1: eth0
QinQ (802.1ad)
--------------
.. cmdinclude:: ../_include/interface-vlan-8021ad.txt
.. cmdinclude:: /_include/interface-vlan-8021ad.txt
:var0: ethernet
:var1: eth0

View File

@ -39,7 +39,7 @@ Configuration
Common interface configuration
==============================
.. cmdinclude:: ../_include/interface-common-without-dhcp.txt
.. cmdinclude:: /_include/interface-common-without-dhcp.txt
:var0: geneve
:var1: gnv0

View File

@ -1,4 +1,4 @@
.. include:: ../_include/need_improvement.txt
.. include:: /_include/need_improvement.txt
.. _l2tpv3-interface:
@ -31,7 +31,7 @@ Configuration
Common interface configuration
==============================
.. cmdinclude:: ../_include/interface-common-without-dhcp.txt
.. cmdinclude:: /_include/interface-common-without-dhcp.txt
:var0: l2tpv3
:var1: l2tpeth0

View File

@ -26,11 +26,11 @@ Configuration
Common interface configuration
==============================
.. cmdinclude:: ../_include/interface-address.txt
.. cmdinclude:: /_include/interface-address.txt
:var0: loopback
:var1: lo
.. cmdinclude:: ../_include/interface-description.txt
.. cmdinclude:: /_include/interface-description.txt
:var0: loopback
:var1: lo

View File

@ -20,7 +20,7 @@ Configuration
Common interface configuration
==============================
.. cmdinclude:: ../_include/interface-common-with-dhcp.txt
.. cmdinclude:: /_include/interface-common-with-dhcp.txt
:var0: macsec
:var1: macsec0

View File

@ -581,4 +581,4 @@ The following commands let you reset OpenVPN.
.. include:: ../common-references.rst
.. include:: /common-references.rst

View File

@ -59,15 +59,15 @@ Configuration
Common interface configuration
==============================
.. cmdinclude:: ../_include/interface-description.txt
.. cmdinclude:: /_include/interface-description.txt
:var0: pppoe
:var1: pppoe0
.. cmdinclude:: ../_include/interface-disable.txt
.. cmdinclude:: /_include/interface-disable.txt
:var0: pppoe
:var1: pppoe0
.. cmdinclude:: ../_include/interface-vrf.txt
.. cmdinclude:: /_include/interface-vrf.txt
:var0: pppoe
:var1: pppoe0
@ -177,7 +177,7 @@ IPv6
Use this command to enable acquisition of IPv6 address using stateless
autoconfig (SLAAC).
.. cmdinclude:: ../_include/interface-dhcpv6-prefix-delegation.txt
.. cmdinclude:: /_include/interface-dhcpv6-prefix-delegation.txt
:var0: pppoe
:var1: pppoe0

View File

@ -45,7 +45,7 @@ Configuration
Common interface configuration
==============================
.. cmdinclude:: ../_include/interface-common-with-dhcp.txt
.. cmdinclude:: /_include/interface-common-with-dhcp.txt
:var0: pseudo-ethernet
:var1: peth0
@ -60,6 +60,6 @@ Pseudo Ethernet/MACVLAN options
VLAN
====
.. cmdinclude:: ../_include/interface-vlan-8021q.txt
.. cmdinclude:: /_include/interface-vlan-8021q.txt
:var0: pseudo-ethernet
:var1: peth0

View File

@ -16,7 +16,7 @@ a closer look at the protocols and options currently supported by VyOS.
Common interface configuration
------------------------------
.. cmdinclude:: ../_include/interface-common-without-dhcp.txt
.. cmdinclude:: /_include/interface-common-without-dhcp.txt
:var0: tunnel
:var1: tun0

View File

@ -39,7 +39,7 @@ Configuration
Common interface configuration
------------------------------
.. cmdinclude:: ../_include/interface-common-without-dhcp.txt
.. cmdinclude:: /_include/interface-common-without-dhcp.txt
:var0: vxlan
:var1: vxlan0

View File

@ -30,7 +30,7 @@ Configuration
Common interface configuration
==============================
.. cmdinclude:: ../_include/interface-common-with-dhcp.txt
.. cmdinclude:: /_include/interface-common-with-dhcp.txt
:var0: wireless
:var1: wlan0
@ -378,14 +378,14 @@ VLAN
Regular VLANs (802.1q)
----------------------
.. cmdinclude:: ../_include/interface-vlan-8021q.txt
.. cmdinclude:: /_include/interface-vlan-8021q.txt
:var0: wireless
:var1: wlan0
QinQ (802.1ad)
--------------
.. cmdinclude:: ../_include/interface-vlan-8021ad.txt
.. cmdinclude:: /_include/interface-vlan-8021ad.txt
:var0: wireless
:var1: wlan0

View File

@ -15,15 +15,15 @@ Configuration
Common interface configuration
==============================
.. cmdinclude:: ../_include/interface-description.txt
.. cmdinclude:: /_include/interface-description.txt
:var0: wirelessmodem
:var1: wlm0
.. cmdinclude:: ../_include/interface-disable.txt
.. cmdinclude:: /_include/interface-disable.txt
:var0: wirelessmodem
:var1: wlm0
.. cmdinclude:: ../_include/interface-vrf.txt
.. cmdinclude:: /_include/interface-vrf.txt
:var0: wirelessmodem
:var1: wlm0

View File

@ -1,4 +1,4 @@
.. include:: _include/need_improvement.txt
.. include:: /_include/need_improvement.txt
.. _nptv6:

View File

@ -1,4 +1,4 @@
.. include:: ../_include/need_improvement.txt
.. include:: /_include/need_improvement.txt
######
Policy
@ -65,7 +65,7 @@ neighbor.
You now see the longer AS path.
.. include:: ../_include/need_improvement.txt
.. include:: /_include/need_improvement.txt
.. _routing-pbr:

View File

@ -143,4 +143,4 @@ order of the scripts.
.. _vyatta-cfg: https://github.com/vyos/vyatta-cfg
.. _bootchart.conf: https://github.com/vyos/vyos-build/blob/current/data/live-build-config/includes.chroot/etc/systemd/bootchart.conf
.. include:: ../common-references.rst
.. include:: /common-references.rst

View File

@ -711,4 +711,4 @@ http://dev.packages.vyos.net/repositories/.
.. _`VLAN (VIF)`: https://github.com/vyos/vyos-1x/tree/current/interface-definitions/include/vif.xml.i
.. _`MAC address`: https://github.com/vyos/vyos-1x/tree/current/interface-definitions/include/interface-mac.xml.i
.. include:: ../common-references.rst
.. include:: /common-references.rst

View File

@ -325,4 +325,4 @@ predefined structure.
.. _reStructuredTextDirectives: https://docutils.sourceforge.io/docs/ref/rst/directives.html
.. _README.md: https://github.com/vyos/vyos-documentation/blob/master/README.md
.. include:: ../common-references.rst
.. include:: /common-references.rst

View File

@ -77,4 +77,4 @@ the left side under the specific project.
.. _Slack: https://slack.vyos.io
.. _Forum: https://forum.vyos.io
.. include:: ../common-references.rst
.. include:: /common-references.rst

View File

@ -1,23 +0,0 @@
.. _advanced_network-interfaces:
##################
Network Interfaces
##################
.. toctree::
:maxdepth: 1
bond
bridge
dummy
ethernet
geneve
loopback
l2tpv3
macsec
pppoe
pseudo-ethernet
tunnel
vxlan
wireless
wirelessmodem

View File

@ -1,12 +0,0 @@
.. _basic_network-interfaces:
########################
Basic Network Interfaces
########################
.. toctree::
:maxdepth: 1
ethernet
loopback
pppoe

View File

@ -1,4 +1,4 @@
.. include:: ../_include/need_improvement.txt
.. include:: /_include/need_improvement.txt
.. _routing-bfd:

View File

@ -1,4 +1,4 @@
.. include:: ../_include/need_improvement.txt
.. include:: /_include/need_improvement.txt
.. _routing-ospf:

View File

@ -1,4 +1,4 @@
.. include:: ../_include/need_improvement.txt
.. include:: /_include/need_improvement.txt
.. _rip:

View File

@ -1,4 +1,4 @@
.. include:: ../_include/need_improvement.txt
.. include:: /_include/need_improvement.txt
Conntrack
---------

View File

@ -1,4 +1,4 @@
.. include:: ../_include/need_improvement.txt
.. include:: /_include/need_improvement.txt
.. _ipoe_server:
@ -146,4 +146,4 @@ The rate-limit is set in kbit/sec.
-------+------------+-------------------+-------------+-----+--------+------------+--------+----------+------------------
ipoe0 | eth2 | 08:00:27:2f:d8:06 | 192.168.0.2 | | | 500/500 | active | 00:00:05 | dccc870fd31349fb
.. include:: ../common-references.rst
.. include:: /common-references.rst

View File

@ -394,4 +394,4 @@ a /56 subnet for the clients internal use.
--------+----------+-------------+--------------------------+---------------------+-------------------+------------+--------+----------+----------+----------
ppp0 | test | 192.168.0.1 | 2001:db8:8002:0:200::/64 | 2001:db8:8003::1/56 | 00:53:00:12:42:eb | | active | 00:00:49 | 875 B | 2.1 KiB
.. include:: ../common-references.rst
.. include:: /common-references.rst

View File

@ -41,5 +41,5 @@ Configuration
.. note:: We can't support all displays from the beginning. If your display
type is missing, please create a feature request via Phabricator_.
.. include:: ../common-references.rst
.. include:: /common-references.rst

View File

@ -344,4 +344,4 @@ A connection attempt will be shown as:
.. _sstpc: https://github.com/reliablehosting/sstp-client
.. include:: ../common-references.rst
.. include:: /common-references.rst