[Docs] Fix badly indented lists and blocks #11660
Merged
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.
We had a bunch of badly indented stuff in the docs that did not quite break the syntax but still got rendered weirdly.
To render a list to properly in .rst:
- x
but e.g. 4 for something like12. x
).The PR also fixes inconsistent indents for code blocks in a few places where I've spotted them while fixing lists. Looks like Sphinx does not enforce any particular indent width here but some of our scripts (e.g.
isolate_tests.py
) expect 4 and won't detect code blocks with a smaller indent. There were also some blocks indented with a mix of tabs and spaces.When reviewing it I recommend taking a look in the mode that ignores whitespace. In that mode the diff should be nearly empty except for newlines (these do not get ignored) and some changed bullet points. There's also one change that adjusts a header.