| Age | Commit message (Collapse) | Author |
|---|
|
|
|
(Copilot review)
|
|
(Copilot review)
|
|
|
|
|
|
|
|
|
|
-> RST
|
|
|
|
review)
|
|
|
|
Wraps the DUID example value in interface-dhcpv6-options.txt with
.. stop_vyoslinter / .. start_vyoslinter pragmas to exclude it from
vyos-linter MAC-pattern checks. Rewraps a long prose line in
interface-ipv6.txt to fit the 80-char limit.
Surfaced when the conversion sweep's doc-lint check failed on the
19th commit. These fixes are separate from the MyST→RST conversion
work but folded into this PR to keep it self-contained.
🤖 Generated by [robots](https://vyos.io)
|
|
cleanup design)
|
|
RST-leftovers cleanup design)
|
|
RST-leftovers cleanup design)
|
|
cleanup design)
|
|
cleanup design)
|
|
cleanup design)
|
|
cleanup design)
|
|
cleanup design)
|
|
RST-leftovers cleanup design)
|
|
cleanup design)
|
|
cleanup design)
|
|
RST-leftovers cleanup design)
|
|
RST-leftovers cleanup design)
|
|
(per RST-leftovers cleanup design)
|
|
RST-leftovers cleanup design)
|
|
RST-leftovers cleanup design)
|
|
RST-leftovers cleanup design)
|
|
cleanup design)
|
|
RST-leftovers cleanup design)
|
|
need_improvement.txt on sagitta
`_include/interface-vlan-8021ad.txt` started with
`.. include:: /_include/need_improvement.txt`. After PR #2008 the
`{cmdincludemd}` directive parses included `.txt` content as RST, so
the three MD pages that consume interface-vlan-8021ad.txt
(ethernet.md:161, virtual-ethernet.md:46, wireless.md:485) reach
need_improvement.txt through an RST parser.
`need_improvement.txt` is now MyST (`::::{only} not latex / :::{admonition}`),
so the RST parser would render those directives as literal text on
three interface pages.
Rolling does not have this regression — rolling's
`_include/interface-vlan-8021ad.txt` is MyST/MD content and does not
include need_improvement.txt at all. The sagitta file is older
RST-shape content with the include chain at the top, an artifact of the
mid-migration state on sagitta.
Strip line 1 (`.. include:: /_include/need_improvement.txt`) and the
blank line that follows. The QinQ overview content below is untouched
and still parses as RST under `{cmdincludemd}`.
Spotted by Copilot inline review on #2026.
🤖 Generated by [robots](https://vyos.io)
|
|
renders correctly (backport #2016)
Manual backport of #2016 to sagitta — Mergify auto-backport failed
because sagitta's version of the file is a partial MyST conversion with
leftover RST garbage (` \fi` line, RST `:ref:` syntax in MyST file).
Same fix as rolling: wrap the MyST admonition in `::::{only} not latex`
to preserve the LaTeX/PDF suppression from the original
`.. raw:: latex \iffalse / \fi` guard. `.readthedocs.yml` declares
`formats: - pdf`, so PDF output is a live downstream artifact.
Sagitta does not have the `{eval-rst}` wrapper around the include
that rolling had, so the highavailability/index.md change from #2016
is not needed here.
🤖 Generated by [robots](https://vyos.io)
|
|
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
|
|
(cherry picked from commit 0ac48851041f43656e08988b2d33fe8eb93da28f)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
