vyos-documentation.git/docs/_include/need_improvement.txt, branch 1.5VyOS readthedocs (mirror of https://github.com/vyos/vyos-documentation.git)
https://git.amelek.net/vyos/vyos-documentation.git/atom?h=1.52026-05-13T22:05:52+00:00fix(includes): wrap admonition in `{only} not latex` to preserve PDF suppression2026-05-13T22:05:52+00:00Yuriy Andamasovyuriy@vyos.io2026-05-13T21:57:01+00:00urn:sha1:015afa1c5eef9f4b3a04ee7145c76ebf9b450221
The original RST `_include/need_improvement.txt` wrapped the admonition
in `.. raw:: latex \iffalse / \fi`, intentionally hiding the
"Call for Contributions" notice from the LaTeX/PDF builder (see
b222a313, 2020). `.readthedocs.yml` enables `formats: - pdf` and
`conf.py` configures `latex_elements`/`latex_documents`, so PDF output
is a real downstream artifact.
The previous commit (82a06e1d) dropped that suppression. Restore it
using Sphinx's `only` directive with `not latex`, which is the MyST
equivalent of the original RST builder-conditional pattern.
Spotted by Copilot inline review on #2016.
🤖 Generated by [robots](https://vyos.io)
(cherry picked from commit 86de2de975cf4958c84d73cdd669be525e4680ea)
fix(includes): rewrite need_improvement.txt as MyST so plain `{include}` renders correctly2026-05-13T22:05:52+00:00Yuriy Andamasovyuriy@vyos.io2026-05-13T20:18:29+00:00urn:sha1:e00e8e38476742ad23c627f77f0e1525f8f7495f
After the RST→MyST migration, ~45 MD pages use the plain `{include}` MyST
directive to pull in `_include/need_improvement.txt`. The included file
still contained RST (`.. raw:: html`, `.. raw:: latex`, `:ref:`), and
MyST's built-in `{include}` parses the content with the *outer* file's
parser — i.e. as MyST. RST directives then render as literal paragraphs.
Visible symptom on docs.vyos.io/en/rolling (and across 1.5/1.4):
the VPP index, VPP subpages, haproxy, isis, bfd, policy, pki, salt,
flowtables, webproxy, and others all show:
.. raw:: latex
\iffalse
.. raw:: html
Call for Contributions
Help improve this section ...
For contribution guidelines, see :ref: documentation .
Fix: rewrite `_include/need_improvement.txt` as a native MyST admonition
(`:::{admonition} Call for Contributions / :class: error / ... / :::`)
and drop the now-unnecessary `{eval-rst}` wrapper at the single callsite
(`configuration/highavailability/index.md`) that wrapped the include for
RST processing.
The fix is companion to 9c815d68 (cmdincludemd RST plumbing) but targets
the plain-`{include}` path which doesn't route through our custom
extension.
🤖 Generated by [robots](https://vyos.io)
(cherry picked from commit 82a06e1dc812ceba239aaabf4acd651a038bfee7)
Proofread files in /vpp directory (#1770)2026-03-02T09:42:37+00:00Quill69414602+teslazonda@users.noreply.github.com2026-03-02T09:42:37+00:00urn:sha1:bf75633052db67e0bfb7900d05e380c3d64cd493
* Proofread description.rst and requirements.rst
* Fixes indentation in aws.rst
* Update need_improvement.txt
* Edit limitations.rst
* Prooofread vpp/troubleshooting.rst
* Fix line length lint errors
* Fix additional line length errors
* Fix final line length errorsinterfaces: add generic QinQ VLAN documentation2020-11-24T18:38:52+00:00Christian Poessingerchristian@poessinger.com2020-11-24T18:38:52+00:00urn:sha1:7399b53b9d09ef07219631f79aeebd87c1b98d1eFIXME: add need_improvement.txt2020-02-25T18:53:07+00:00Robert Göhlergithub@ghlr.de2020-02-25T18:53:07+00:00urn:sha1:b222a3133ad34daa2371a489d537cfadbde6b05f