Sphinx (RST)

LookUp for Sphinx-Syntax

• https://sublime-and-sphinx-guide.readthedocs.io/en/latest/code_blocks.html

• https://documentation.help/Sphinx/inline.html

Sphinx supported Languages

• https://pygments.org/languages/

Sections

Section headers (ref) are created by underlining (and optionally overlining) the section title with a punctuation character, at least as long as the text:

This is a heading

Normally, there are no heading levels assigned to certain characters as the structure is determined from the succession of headings. However, this convention is used in Python Developer’s Guide for documenting which you may follow:

# with overline, for parts
* with overline, for chapters
= for sections
- for subsections
^ for subsubsections
" for paragraphs

Citation/Referance

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

Here is a citation reference: [CIT2002]_.

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

Notes and Warnings

.. note::
.. warning::