List of Symbols

Text Formatting

  • *: Asterisk for emphasis (italic or bold)

  • **: Double asterisk for strong emphasis (bold)

  • `: Backtick for inline code or literals

  • =: Equals sign for underlining titles

  • -: Hyphen for bullet points or underlining subtitles

  • #: Hash symbol for numbered lists

  • ::: Double colon for literal blocks

  • |: Vertical bar for substitution references

  • ..: Double dot for comments or directives

  • []: Square brackets for hyperlinks or citations

Code Recognition

  • .. code-block:: language: Directive for syntax-highlighted code blocks.

    Example:

    def hello():
        print("Hello, world!")
    
  • ::: Double colon for literal blocks (unhighlighted code).

    Example:

    This is a literal block of text or code.
    

Tables

  • .. table::: Directive for creating tables

    Example:

    .. table:: Sample Table
    
    widths:

    auto