summaryrefslogtreecommitdiff
path: root/docs/_include/interface-common-without-mac.txt
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-05-06 18:46:21 +0300
committerYuriy Andamasov <yuriy@vyos.io>2026-05-06 18:46:21 +0300
commit88957530a3e174bfc61e8358cb2b28fd8f1fbbb6 (patch)
tree22b30d717e61a573a3712efec8a60f3e6b409d97 /docs/_include/interface-common-without-mac.txt
parentc784d8880325f96423fdd2c558750cac4313a56e (diff)
downloadvyos-documentation-88957530a3e174bfc61e8358cb2b28fd8f1fbbb6.tar.gz
vyos-documentation-88957530a3e174bfc61e8358cb2b28fd8f1fbbb6.zip
feat: import MyST swap mechanism + content for sagitta (replaces #1886)
Replaces the broken #1886 with a fresh, properly-converted MyST set for the sagitta (1.4.x) docs, mirroring what landed for circinus via #1897. This PR: - Re-imports 210 md-*.md files for sagitta. Source: ran the pipelines rst-to-myst converter (chrisjsewell/rst-to-myst v0.4.0, with pandoc fallback) on sagittas RST. Post-processed via the pipelines postprocess stage (10 ordered fixes for blanks, admonitions, label hyphens, pandoc artifacts, structural blanks, linter markers). Compared to the broken #1886 content (which was left over from an earlier stage-1-only run): zero raw `<div class=>` remnants. - For 23 stems where sagittas RST is byte-identical with currents RST (mostly stable policy/protocol pages and the 404 page), reuses currents already-validated md-*.md content rather than re-converting. - Drops cli and installation/cloud/aws from sagittas swap set: their RST has SEVERE/4 "Title level inconsistent" errors that crash rst-to-myst; they need an independent RST-source fix and are kept as RST-only for now. - Adds the per-page swap mechanism: scripts/swap_sources.py, scripts/import_myst.py, the matching tests under tests/, _swap.txt with 210 stems, _ext/vyos.py MyST renderer fallback, Makefile swap-wrapped targets, .readthedocs.yml swap pre/post hooks. - Adds 187 .webp images and removes 235 superseded .jpg/.png/.jpeg static assets; flips html_logo to vyos-logo.webp. - Adds the MyST swap-related blocks to docs/conf.py only: myst_enable_extensions, myst_fence_as_directive, md-*.md exclude patterns, _swap_exclude.txt reader, _prefer_webp and _copy_md_sources setup hooks. github_version fallback set to 'sagitta' to match the branch (parallel to currents 'current' and circinuss 'circinus'). Deliberately excluded (per user direction): - llms.txt and sphinx-llms-txt / sphinx-sitemap config: these will land separately for sagitta via #1870 plus a new sagitta-specific llms.txt template PR. The conf.py here does not pull those extensions in, so the build does not depend on the new pip packages. Verification before pushing: - 210 md-*.md = 210 _swap.txt stems = 210 RST siblings on sagitta (1:1:1). - 0 files contain raw `<div class=` (the breakage that took down /en/1.5/). - conf.py copyright/version/release preserve sagittas values (2024 / 1.4 / "1.4.x (sagitta)") - not currents. - html_title from currents conf.py removed - PR #1880 is the right place for sagittas branch-localized title. Supersedes / closes on merge: - #1886 (broken converter output, would break /en/1.4/ if merged). Generated by robots https://vyos.io
Diffstat (limited to 'docs/_include/interface-common-without-mac.txt')
-rw-r--r--docs/_include/interface-common-without-mac.txt32
1 files changed, 24 insertions, 8 deletions
diff --git a/docs/_include/interface-common-without-mac.txt b/docs/_include/interface-common-without-mac.txt
index cc01db12..4803d4ca 100644
--- a/docs/_include/interface-common-without-mac.txt
+++ b/docs/_include/interface-common-without-mac.txt
@@ -1,31 +1,47 @@
-.. cmdinclude:: /_include/interface-description.txt
+```{cmdincludemd} /_include/interface-description.txt
+```
+
:var0: {{ var0 }}
:var1: {{ var1 }}
-.. cmdinclude:: /_include/interface-disable.txt
+```{cmdincludemd} /_include/interface-disable.txt
+```
+
:var0: {{ var0 }}
:var1: {{ var1 }}
-.. cmdinclude:: /_include/interface-disable-flow-control.txt
+```{cmdincludemd} /_include/interface-disable-flow-control.txt
+```
+
:var0: {{ var0 }}
:var1: {{ var1 }}
-.. cmdinclude:: /_include/interface-disable-link-detect.txt
+```{cmdincludemd} /_include/interface-disable-link-detect.txt
+```
+
:var0: {{ var0 }}
:var1: {{ var1 }}
-.. cmdinclude:: /_include/interface-mtu.txt
+```{cmdincludemd} /_include/interface-mtu.txt
+```
+
:var0: {{ var0 }}
:var1: {{ var1 }}
-.. cmdinclude:: /_include/interface-ip.txt
+```{cmdincludemd} /_include/interface-ip.txt
+```
+
:var0: {{ var0 }}
:var1: {{ var1 }}
-.. cmdinclude:: /_include/interface-ipv6.txt
+```{cmdincludemd} /_include/interface-ipv6.txt
+```
+
:var0: {{ var0 }}
:var1: {{ var1 }}
-.. cmdinclude:: /_include/interface-vrf.txt
+```{cmdincludemd} /_include/interface-vrf.txt
+```
+
:var0: {{ var0 }}
:var1: {{ var1 }}