Formatting examples

In all cases, click the “Page Source” link in the footer to inspect the source code that generates the content here.

Inline examples

• filename role for filenames

• key keyboard role

• term role for terms

• guilabel for indicating GUI elements to interact with

• example_package.example.Demo links to a documented class

• example_package.example.super_complex_operation() links to a documented function

• example_package.example.Demo.run() links to a documented method

• super_complex_operation(), after setting .. currentmodule:: example_package.example

Code examples

# Example of syntax highlighting for Python
import this
for i in range(len(x)):
    print(x)
    if i > 10:
        raise ValueError('too high!')

# Some bash
export PATH="$PATH:/opt/bin"
$(echo "ls") /opt/bin &> log

Paragraph-level markup

Warning

Yikes.

Note

Noted.

See also

Nothing to see here.