Formats¶
In Sphinx, you can use reStructuredText (reST) format to write documentation. The following is a tutorial on how to use bold, italic in Sphinx documentation.
Bold¶
In reST, you can use double asterisks **
to indicate bold text.
Example:
**This is bold text**
Rendered result:
This is bold text
Italic¶
Italic text can be indicated using single asterisks *
.
Example:
*This is italic text*
Rendered result:
This is italic text