Reformat RST to avoid sphinx warnings

Old versions of docutils will see inline markup (e.g., :ref:`foo`)
at the beginning of a line in the content of a directive block
and attempt to interpret that markup as options or arguments
to the directive.  RST intended as inline markup (as opposed to
modifying the behavior of the directive) will not be interpretable
in this context, and causes Sphinx to emit a warning.

Work around this behavior by always leaving a blank line before
the content of a directive block, forcing it to be interpreted
as content and not options or arguments.

The buggy behavior was only encountered in note environments, but
for consistency of style, also reformat warning and error blocks.

Note the new style constraint in doc/README.

ticket: 7469 (new)
title: doc buildslave generates sphinx warnings
tags: pullup
target_version: 1.11

1 files changed, 4 insertions, 0 deletions

diff --git a/doc/README b/doc/README
index 8bb1c47cc..a49d11038 100644
--- a/doc/README
+++ b/doc/README
@@ -67,3 +67,7 @@ We use the following conventions:
   to indicate optional parameters).  If immediately following one kind
   of inline markup with another or putting inline markup next to
   punctuation, you may need to use "\ " as a dummy separator.
+
+* For directives that take a content block (e.g., note, error, and
+  warning), leave a blank line before the content block (after any
+  arguments or options that may be present).