Skip to content

Commit 6420cd9

Browse files
joestringerjoestringer
committed
docs: Ignore YAML multiple document error
The new version of rstcheck complains: network/kubernetes/kubeproxy-free.rst:1011: (ERROR/3) (yaml) expected a single document in the stream in "<unicode string>", line 1, column 1: apiVersion: v1 ^ but found another document in "<unicode string>", line 14, column 1: --- ^ The error repeats a few times. In many cases, we want to include a full kubernetes YAML example that includes multiple resources, such as a Kubernetes Service and its corresponding EndpointSlices. Therefore it's not critical for all of the YAML documents in the tree to conform to completely standard YAML; multi-document YAMLs is commonly accepted syntax for kubectl tools that we would work with. Signed-off-by: Joe Stringer <[email protected]>
1 parent cb21a81 commit 6420cd9

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

‎Documentation/check-build.sh‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,7 @@ run_linter() {
159159
ignored_messages="${ignored_messages}|Duplicate implicit target name:"
160160
ignored_messages="${ignored_messages}|\(ERROR/3\) Indirect hyperlink target \".*\" refers to target \"${CONF_PY_TARGET_NAMES}\", which does not exist."
161161
ignored_messages="${ignored_messages}|\(ERROR/3\) Unknown target name: \"${CONF_PY_TARGET_NAMES}\"."
162+
ignored_messages="${ignored_messages}|.*expected a single document in the stream.*"
162163
ignored_messages="${ignored_messages})"
163164
# Filter out the AttributeError reports that are due to a bug in rstcheck,
164165
# see https://github.com/rstcheck/rstcheck-core/issues/3.

0 commit comments

Comments
 (0)