Inline Markup
On this page
Inline markup, also known as roles, specify how the enclosed text should be interpreted or rendered.
To learn more about roles, see the Docutils documentation.
Sphinx provides an extended set of roles. To learn more about the extended roles, see the Sphinx documentation.
Font Formatting Roles
These roles control how the font of the enclosed text renders.
To learn more about when to use these roles, see the style guide section on Text Formatting.
To strongly emphasize or bold text, use two asterisks on both sides of the text.
**bold** To emphasize or italicize text, use one asterisk on both sides of the text.
*italic* To specify
monospacetext, use two backticks on both sides of the text.``monospace``
Use the following guidelines to avoid errors in font formatting roles:
Don't start or end markup with whitespace.
UseAvoid**bold code** ** bold code** Don't apply more than one type of markup to text.
UseAvoid``bold code`` **``bold code``** When you apply a text formatting role to the middle of a word, use a backslash and space character on both sides of the formatted text.
UseAvoidthis is *four* words thisis\ *one*\ word thisis*one*word