Skip to content

docs: Fix some "parsed-literal" blocks#44385

Merged
joestringer merged 3 commits intomainfrom
pr/qmonnet/fix-parsed-literals
Feb 17, 2026
Merged

docs: Fix some "parsed-literal" blocks#44385
joestringer merged 3 commits intomainfrom
pr/qmonnet/fix-parsed-literals

Conversation

@qmonnet
Copy link
Copy Markdown
Member

@qmonnet qmonnet commented Feb 16, 2026

Fix some of the formatting for generated HTML docs: use parsed-literal blocks instead of the code-block directive for a few instances where substitution patterns have to be replaced by Sphinx, remove the redundant --version argument already provided by |CHART_VERSION|, and adjust markers for line splitting.

Issues found while reviewing #44380.

@qmonnet qmonnet added the release-note/misc This PR makes changes that have no direct user impact. label Feb 16, 2026
@qmonnet qmonnet requested review from a team as code owners February 16, 2026 12:06
The snippet contains a |CHART_VERSION| directive that is not substituted
when generating the docs, because it's under a "code-block" directive
instead of a "parsed-literal".

Fix the directive, adjust backslashes accordingly, and remove the
redundant "--version" argument (already generated when expanding
|CHART_VERSION|).

Trim trailing white spaces in the file.

Fixes: 63bfe7d ("Added GKE-to-GKE Clustermesh Preparation guide")
Signed-off-by: Quentin Monnet <qmo@qmon.net>
The snippet contains a |CHART_VERSION| directive that is not substituted
when generating the docs, because it's under a "code-block" directive
instead of a "parsed-literal".

Fix the directive, adjust backslashes accordingly, and remove the
redundant "--version" argument (already generated when expanding
|CHART_VERSION|).

Trim trailing white spaces in the file.

Fixes: b76f928 ("docs: add Helm configuration instructions for metrics")
Signed-off-by: Quentin Monnet <qmo@qmon.net>
For "parsed-literal" blocks, we need a double-backslash at the end of
the line to make a single "\" appear in the generated HTML docs. With a
single one in the source, Sphinx remove the line breaks and leaves
multiple spaces (from the indentation on the next line) instead.

Go through multiple locations (all that I could find) in the docs where
we have parsed-literal blocks with single backslashes to mark a command
split, and adjust with double backslashes instead.

For .../sbom.rst, also add the missing indentation marking the
continuation of the command line.

Trim trailing white spaces, if any, in all edited files.

Signed-off-by: Quentin Monnet <qmo@qmon.net>
@qmonnet qmonnet force-pushed the pr/qmonnet/fix-parsed-literals branch from e766a32 to b96f45b Compare February 16, 2026 12:10
Copy link
Copy Markdown
Member

@MrFreezeex MrFreezeex left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Quentin 🙏

@qmonnet
Copy link
Copy Markdown
Member Author

qmonnet commented Feb 16, 2026

/test

@qmonnet qmonnet added the area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. label Feb 17, 2026
Copy link
Copy Markdown
Member

@joestringer joestringer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 🙏

@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Feb 17, 2026
@joestringer joestringer added needs-backport/1.19 This PR / issue needs backporting to the v1.19 branch and removed ready-to-merge This PR has passed all tests and received consensus from code owners to merge. labels Feb 17, 2026
@maintainer-s-little-helper maintainer-s-little-helper bot added the ready-to-merge This PR has passed all tests and received consensus from code owners to merge. label Feb 17, 2026
@joestringer joestringer added this pull request to the merge queue Feb 17, 2026
Merged via the queue into main with commit 920027d Feb 17, 2026
74 checks passed
@joestringer joestringer deleted the pr/qmonnet/fix-parsed-literals branch February 17, 2026 17:54
@YutaroHayakawa YutaroHayakawa mentioned this pull request Feb 24, 2026
21 tasks
@YutaroHayakawa YutaroHayakawa added backport-pending/1.19 The backport for Cilium 1.19.x for this PR is in progress. and removed needs-backport/1.19 This PR / issue needs backporting to the v1.19 branch labels Feb 24, 2026
@github-actions github-actions bot added backport-done/1.19 The backport for Cilium 1.19.x for this PR is done. and removed backport-pending/1.19 The backport for Cilium 1.19.x for this PR is in progress. labels Mar 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. backport-done/1.19 The backport for Cilium 1.19.x for this PR is done. ready-to-merge This PR has passed all tests and received consensus from code owners to merge. release-note/misc This PR makes changes that have no direct user impact.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants