]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/start: add RST escape character rules for bold 49752/head
authorZac Dover <zac.dover@gmail.com>
Sun, 15 Jan 2023 10:45:28 +0000 (20:45 +1000)
committerZac Dover <zac.dover@gmail.com>
Mon, 16 Jan 2023 02:57:09 +0000 (12:57 +1000)
Explain how to escape the bold notation (**) within words in RST.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
(cherry picked from commit 84524c264638710dd7d00a193e25a511cd0de19d)

doc/start/documenting-ceph.rst

index 93b266d1630c277d436c64806469b45b15465685..4954112be39412669b2e221572aee4720ffc2279 100644 (file)
@@ -778,6 +778,27 @@ Link to target with inline text::
    documentation<external_link_with_inline_text>`. If this seems inconsistent
    and confusing to you, then you're right. It is inconsistent and confusing.
 
+Escaping Bold Characters within Words
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This section explains how to make certain letters within a word bold while
+leaving the other letters in the word regular (non-bold). 
+
+The following single-line paragraph provides an example of this:
+
+**C**\eph **F**\ile **S**\ystem.
+
+In ReStructured Text, the following formula will not work:
+
+::
+
+   **C**eph **F**ile **S**ystem
+
+The bolded notation must be turned off by means of the escape character (\\), as shown here:
+
+::
+
+   **C**\eph **F**\ile **S**\ystem
 
 .. _Python Sphinx: https://www.sphinx-doc.org
 .. _restructuredText: http://docutils.sourceforge.net/rst.html