:title: rST Extensions
:date: 2022-09-29

===========================
reStructuredText Extensions
===========================

rSW includes support for a few directives and roles that are not part of
Docutils.

code-block
==========

Example:

.. code-block:: text

    .. code-block:: python

        if __name__ == "__main__":
            # [initialize]
            app.start(":8000")
            # [initialize]

Result:

.. code-block:: python

    if __name__ == "__main__":
        # [initialize]
        app.start(":8000")
        # [initialize]

TODO
====

In plan:

* Fully featured ``code-block`` (as in `Sphinx`_)
* Deleted text (`<del>`)
* Inserted text (`<ins>`)
* Keystrokes mark (``:kbd:``)
* Spoilers (`<details>`, `<summary>`)
* Table of Contents (``toctree``)
* Abbreviations (``:abbr:``)

.. _Sphinx: https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block