From: Ken Dreyer <kdreyer@redhat.com>
Date: Wed, 26 Oct 2016 01:44:57 +0000 (-0600)
Subject: doc: fix mgr literal block rST syntax
X-Git-Tag: v11.1.0~509^2
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=refs%2Fpull%2F11652%2Fhead;p=ceph.git

doc: fix mgr literal block rST syntax

Prior to this change, there were double-colon ("::") characters in the
HTML docs to indicate literal blocks.

The proceeding paragraphs were not pre-formatted because there was no
newline between the double-colon and the to-be-pre-formatted paragraph.

Move the "::" characters inline to simplify the syntax and make Sphinx
properly interpret these texts as literal blocks.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
---

diff --git a/doc/mgr/administrator.rst b/doc/mgr/administrator.rst
index f62b01eee6f9..8db733c1c4ee 100644
--- a/doc/mgr/administrator.rst
+++ b/doc/mgr/administrator.rst
@@ -5,23 +5,20 @@ ceph-mgr administrator's guide
 Setup
 -----
 
-Create an authentication key for your daemon:
+Create an authentication key for your daemon::
 
-::
     ceph auth get-or-create mgr.$name mon 'allow *'
 
 Place that key into ``mgr data`` path, which for a cluster "ceph"
 and mgr $name "foo" would be ``/var/lib/ceph/mgr/ceph-foo``.
 
-Start the ceph-mgr daemon:
+Start the ceph-mgr daemon::
 
-::
     ceph-mgr -i $name
 
 Check that the mgr has come up by looking at the output
-of ``ceph status``, which should now include a mgr status line:
+of ``ceph status``, which should now include a mgr status line::
 
-::
     mgr active: $name
 
 High availability
@@ -45,9 +42,7 @@ Calling module commands
 -----------------------
 
 Where a module implements command line hooks, using the Ceph CLI's
-``tell`` command to call them like this:
-
-::
+``tell`` command to call them like this::
 
     ceph tell mgr <command | help>
 
diff --git a/doc/mgr/plugins.rst b/doc/mgr/plugins.rst
index 2cd60256421a..a735ed1122e4 100644
--- a/doc/mgr/plugins.rst
+++ b/doc/mgr/plugins.rst
@@ -48,9 +48,8 @@ Exposing commands
 -----------------
 
 Set the ``COMMANDS`` class attribute of your plugin to a list of dicts
-like this:
+like this::
 
-::
     COMMANDS = [
         {
             "cmd": "foobar name=myarg,type=CephString",