Working with restructured text files

Caution

This page is currently undergoing development.

Bold

**text**

Italics

*text*

Bullets

* text

Numbered list

Option #1:

1. Item 1
2. Item 2

or Option #2 (gives the same output):

#. Item 1
#. Item 2

Separate sections with headings

MAIN HEADING
===============

Sub-heading
--------------

Sub-sub-heading
++++++++++++++++

Edit/add directives (.. directive::)

Examples

  • Insert a figure

    .. figure:: /images/sheffield-logo.jpg

  • Insert an inline image, such as a button icon

    .. |button_name| image:: /images/buttons/button_name.png

  • Include table of contents

    .. toctree::

  • Add a note box

    .. note:: This is a note box.

  • Add a warning box

    .. warning:: This is a warning box.

  • Add customised text box

    .. admonition:: Customised text box

Customise directive features on newly indented line directly underneath directive

..toctree::
        :maxdepth: 5
        :caption: Contents:

.. figure:: /images/sheffield-logo.jpg
        :align: right

Display text on newly indented line underneath directive with space separating lines

.. admonition:: Customised text box

        This is a customised text box.

.. figure:: /images/sheffield-logo.jpg
        :align: right

        University of Sheffield logo