s: Halt build on pfsc- directives with bad opt block in Sphinx pages #94
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It will likely be a common error in Sphinx pages, to have an invalid option block in
pfsc-
directives whenever a PF-JSON object is the value of any of the data fields. This is because there may be a tendency to indent the closing brace in line with the option name, like this:whereas in fact it needs to be indented deeper than the option name, like this:
Up to now, an error of this kind, which Sphinx calls an "invalid option block" is simply reported by Sphinx as a warning, which does not halt the build process. In such a case, the widget simply produces no HTML whatsoever. This means you can have a "successful" build, and yet wind up with a Sphinx page in which one or more of your widgets simply does not appear at all.
We now elevate such Sphinx warnings to actual build-halting errors, so that the user is made aware of the issue.