Basic Formatting
================

Paragraphs
----------

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#paragraphs

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
incididunt ut labore et dolore magna aliqua.  Ut enim ad minim veniam, quis
nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu
fugiat nulla pariatur.  Excepteur sint occaecat cupidatat non proident, sunt in
culpa qui officia deserunt mollit anim id est laborum.

Curabitur pretium tincidunt lacus.  Nulla gravida orci a odio.  Nullam varius,
turpis et commodo pharetra, est eros bibendum elit, nec luctus magna felis
sollicitudin mauris.  Integer in mauris eu nibh euismod gravida.  Duis ac tellus
et risus vulputate vehicula.  Donec lobortis risus a elit.  Etiam tempor.  Ut
ullamcorper, ligula eu tempor congue, eros est euismod turpis, id tincidunt
sapien risus a quam.  Maecenas fermentum consequat mi.  Donec fermentum.
Pellentesque malesuada nulla a mi.  Duis sapien sem, aliquet nec, commodo eget,
consequat quis, neque.  Aliquam faucibus, elit ut dictum aliquet, felis nisl
adipiscing sapien, sed malesuada diam lacus eget erat.  Cras mollis scelerisque
nunc.  Nullam arcu.  Aliquam consequat.  Curabitur augue lorem, dapibus quis,
laoreet et, pretium ac, nisi.  Aenean magna nisl, mollis quis, molestie eu,
feugiat in, orci.  In hac habitasse platea dictumst.

----

After the line.


Compound Paragraphs
-------------------

https://docutils.sourceforge.io/docs/ref/rst/directives.html#compound-paragraph

.. compound::

    The code ::

        print('Hello, world!')

    will show a message.


.. admonition:: Compound paragraph in admonition

    .. compound::

        The code ::

            print('Hello, world!')

        will show a message.

.. topic:: Compound paragraph in topic

    .. compound::

        The code ::

            print('Hello, world!')

        will show a message.


Line Blocks
-----------

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks

| Manual
| line breaks.


Inline Markup
-------------

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#inline-markup

Normal ``Inline Literal`` *Emphasis* **Strong Emphasis**.

Multiple    spaces are   not   collapsed in inline literals: ``a   b  c``.
``very/long/literals/are/broken/without/inserting/a/hyphen``.
``averyveryveryverylongsinglewordisalsoforciblybrokenatsomepointwithoutinsertingahyphen``.

Hyperlinks
----------

https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks

Internal_ link, external_ link.

.. _internal: `Inline Markup`_
.. _external: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html

Other page: :doc:`code-blocks`.

Some file: :download:`insipid.png`.

Math equation: :eq:`euler`.


Footnotes
---------

https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#footnotes

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#footnotes

Footnote [#numbered]_ and [*]_.
And some more:
[#popular-label]_,
[#popular-label]_,
[#popular-label]_,
[#popular-label]_.

.. [#numbered] This is an auto-numbered footnote.
    There is a lot of additional text, so there will be a line break
    and we will see how the second line is indented.
.. [#popular-label] Auto-numbered, multiple mentions.
.. [*] This is an auto-symbol footnote.

.. admonition:: :doc:`Admonition <admonitions>` title
    with footnote [#admonition-title]_

    Footnote [*]_ in ``admonition`` text.

    .. [*] This is probably not used very often.
    .. [#admonition-title] This probably even less.

.. warning::

    Footnote [*]_ in ``warning`` text.

    .. [*] See above.

.. seealso::

    Footnote [*]_ in ``seealso`` text.

    .. [*] See above.

.. topic:: :ref:`Topic` title with footnote [#topic-title]_

    Footnote [*]_ in ``topic`` text.

    .. [*] See above.
    .. [#topic-title] See above.

.. sidebar:: :ref:`Sidebar` title with footnote [#sidebar-title]_

    Footnote [*]_ in ``sidebar`` text.

    .. [*] See above.
    .. [#sidebar-title] See above.



Citations
---------

https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#citations

https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#citations

Here is a citation reference: :title-reference:`The Title` [CIT2002]_.
And another citation reference: [CIT2020]_.
Another mention of the same citation: [CIT2020]_.

.. [CIT2002] This is the citation.  It's just like a footnote,
    except the label is textual.

.. [CIT2020] A literature reference with multiple back-links.
    There is a lot of description text here,
    which will probably lead to a line break.

Other Semantic Markup
---------------------

https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#other-semantic-markup

abbr: :abbr:`LIFO (last-in, first-out)` --
command: :command:`rm` --
dfn: :dfn:`term` --
file: :file:`name.{ext}` --
guilabel: :guilabel:`&Cancel` --
kbd (separate): :kbd:`Control` + :kbd:`x` :kbd:`Control` + :kbd:`f` --
kbd (combined, needs Sphinx >= 3.5.0): :kbd:`Control+x Control+f` --
mailheader: :mailheader:`Content-Type` --
makevar: :makevar:`AM_CFLAGS` --
manpage: :manpage:`ls(1)`, :manpage:`man` --
menuselection: :menuselection:`Start --> &Programs` --
mimetype: :mimetype:`text/plain` --
newsgroup: :newsgroup:`comp.lang.python` --
program: :program:`rm` --
regexp: :regexp:`a*` --
samp: :samp:`print(1+{variable})` (as compared to :code:`print(1)`) --
pep: :pep:`8` --
rfc: :rfc:`2822`
