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, 3 insertions, 1 deletions

diff --git a/doc/plugindev/profile.rst b/doc/plugindev/profile.rst
index 671d4c18c..7dbfdbfc9 100644
--- a/doc/plugindev/profile.rst
+++ b/doc/plugindev/profile.rst
@@ -6,7 +6,9 @@ configuration information is obtained by the Kerberos library and
 applications.  For a detailed description of the profile interface,
 see the header file ``<profile.h>``.
 
-.. note:: The profile interface does not follow the normal conventions
+.. note::
+
+          The profile interface does not follow the normal conventions
           for MIT krb5 pluggable interfaces, because it is part of a
           lower-level component of the krb5 library.