Kitchen Sink

This is meant to show all elements available from Sphinx and its extensions.

For a more complete showcase see Furo theme website.

The focus here is on reStructuredText syntax, but some things in MarkDown (MD) are also shown.

Warning

While sphinx natively supports reStructuredText, MarkDown support has to be enabled via MyST-Parser (see here). Some inhomogeneities may be present between otputs from rST and MD sources.

Important

For MD syntax see the MyST documentation.

As a general thing, you might need to add comments in the rST/MD sources. This is the syntax:

rST syntax

.. This is a comment.
   NB It's best to avoid this syntax because the
   beginning of the comment could match a directive
   and cause problems.

..
   Use this syntax instead

.. 
   _this way beginning with an underscore like this
   is not a problem.

MD syntax

% This is a comment (the way MyST enables them)

<!---
You may also use standard HTML tags
for multiline comments.
-->

• Text elements
• Admonitions
• Showing code
• Math
• sphinx-design elements