Sphinx Cheatsheet

Warning

Very early draft, a complete rewrite in progress.

Sphinx Links

• Sphinx HomePage

• Sphinx Tutorial

• Sphinx Cheatsheet

• Sphinx Extensions

Restructured Text Links

• reStructuredText

• reStructuredText Primer

• Thomas Cokelaer

• Read the Docs theme

• PyCharm reStructuredText support

• PEP 287 – reStructuredText Docstring Format

• reStructuredText Code Block Directive

Document format

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

To Be Checked Links

• Sphinx - Restructured Text - https://www.sphinx-doc.org/en/master/usage/configuration.html - https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html - https://www.sphinx-doc.org/en/master/usage/markdown.html - https://myst-parser.readthedocs.io/en/latest/index.html

• Openalea Sphinx

• Example pypi project

• reStructuredText Directives

• reStructuredText Markup Specification

• Online reStructure Editor (reStructure)

• Sphinx Domains

Miscellaneous

    .. figure:: ../images/new-sync-project.png
        :width: 500px
        :align: center
        :height: 350px
        :alt: New Synchronized Project
        :figclass: align-center

    New Synchronized Project.

    :Eclipse: File -> New -> Other -> Synchronized Project
    .. image:: ../images/new-sync-project.png
:width: 500px
:align: center
:height: 350px

    .. note::  This is a **note** box.