RST Examples

Code

.. versionadded:: 2.2    This was added new in version 2.2.    .. code-block:: php        echo 'Hello World';

Result

echo 'Hello World';

Code

.. code-block:: php    echo 'Hello World';

.. code-block:: console    echo "Hello World"

Result

echo 'Hello World';

echo "Hello World"

Code

.. caution::    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.

.. hint::    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.

.. note::    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.

.. tip::    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.

.. warning::    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.

.. note::    Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque dignissim feugiat imperdiet. Pellentesque porta elit lobortis lacinia fringilla. Donec scelerisque iaculis mi, ultricies molestie ipsum laoreet varius.    .. versionadded:: 2.4    .. code-block:: php        echo 'Hello World';    .. code-block:: console        echo "Hello World"

Result

echo 'Hello World';

echo "Hello World"

RST

.. configuration-block::    .. code-block:: php        echo 'Hello World';    .. code-block:: json        {            "Hello": "World"        }    .. code-block:: sql        SELECT username, active FROM users WHERE username = 'jwage'    .. code-block:: yaml        username: jwage        active: true

Result

echo 'Hello World';

{    "Hello": "World"}

SELECT username, active FROM users WHERE username = 'jwage'

username: jwageactive: true

RST

- List Item 1  - List Child 1  - List Child 2- List Item 2- List Item 3

Result

• List Item 1

  • List Child 1
  • List Child 2
• List Item 2
• List Item 3

RST

+------------------------+------------+----------+----------+| Header row, column 1   | Header 2   | Header 3 | Header 4 || (header rows optional) |            |          |          |+========================+============+==========+==========+| body row 1, column 1   | column 2   | column 3 | column 4 |+------------------------+------------+----------+----------+| body row 2             | ...        | ...      |          |+------------------------+------------+----------+----------+

Result

RST

=====  =====  =======A      B      A and B=====  =====  =======False  False  FalseTrue   False  FalseFalse  True   FalseTrue   True   True=====  =====  =======

Result