gmt-fork/doc/rst/source/rst-cheatsheet.rst

reStructuredText Cheatsheet
###########################

The GMT documentations are written in `reStructureText (ReST) <https://docutils.sourceforge.io/rst.html>`_
and built by `Sphinx <https://www.sphinx-doc.org/>`_.
Here is a quick and dirty cheat sheet for some common ReST stuff used in GMT documentations.
You can see the literal source code of the ReST file on the right,
and the rendered web page on the left.

.. note::

    Try a online reStructuredText editor (e.g. http://rst.ninjs.org/),
    if you want to preview texts written in ReST.

    For a more complete description of ReST syntax, please visit
    `the Sphinx documentation <http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_.

.. raw:: html

   <div style="float: left; width:49%">

.. include:: rst-cheatsheet.rst_

.. raw:: html

   </div>
   </div>
   <div style="float: right; width:49%">

.. literalinclude:: rst-cheatsheet.rst_
   :language: none

.. raw:: html

   </div>