.. https://devguide.python.org/documentation/markup/#sections https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections # with overline, for parts : ###################################################################### * with overline, for chapters : ********************************************************************** = for sections : ====================================================================== - for subsections : ---------------------------------------------------------------------- ^ for subsubsections : ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ " for paragraphs : """""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""" .. # https://rsted.info.ucl.ac.be/ # https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#paragraph-level-markup # https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#footnotes # https://documatt.com/restructuredtext-reference/element/admonition.html # attention, caution, danger, error, hint, important, note, tip, warning, admonition, seealso # versionadded, versionchanged, deprecated, versionremoved, rubric, centered, hlist .. _documentation-learning-resources-index: ================================ Documentation Learning Resources ================================ ---------------------------- reStructuredText & Sphinx ---------------------------- Create intelligent and beautiful documentation with ease * `https://www.sphinx-doc.org/ `_ * `https://docutils.sourceforge.io/rst.html `_ * `The reStructuredText Cheat Sheet: Syntax Reminders `_ ---------------------------- Documentation with Sphinx ---------------------------- * `https://labs.bilimedtech.com `_ * `https://lpn-doc-sphinx-primer-devel.readthedocs.io `_ ------------------ Terminology ------------------ * `https://insightful-data-lab.com `_