From 84524c264638710dd7d00a193e25a511cd0de19d Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Sun, 15 Jan 2023 20:45:28 +1000 Subject: [PATCH] doc/start: add RST escape character rules for bold Explain how to escape the bold notation (**) within words in RST. Signed-off-by: Zac Dover --- doc/start/documenting-ceph.rst | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/doc/start/documenting-ceph.rst b/doc/start/documenting-ceph.rst index 5c885dc3b7c6..ac4fa63651d1 100644 --- a/doc/start/documenting-ceph.rst +++ b/doc/start/documenting-ceph.rst @@ -773,6 +773,27 @@ Link to target with inline text:: documentation`. 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 -- 2.47.3