.RST

Introduction

reStructuredText is a plain text markup language from the Docutils project, released in 2002 for Python documentation. Like Markdown it stays readable as written, but it is more strictly defined and can be extended with directives, which makes it suited to large technical manuals. It is the default language of the Sphinx documentation generator, which builds the documentation of Python itself and of many other projects.

Structure

An RST file is plain text, normally UTF-8. A heading is a line of text underlined, and optionally overlined, with a row of punctuation such as = or -; the order in which styles first appear sets the heading levels. *text* and **text** give emphasis, double backticks mark code, and lists start with -, * or numbers. Directives start with two dots and end with two colons, such as .. note:: or .. image:: photo.png, and roles such as :ref:`intro` mark text inline. Indentation shows what belongs to a directive or list item.

Installation
============

Run the installer, then check the version:

.. code-block:: console

   $ tool --version

.. note::
   You need **administrator** rights on Windows.

Links