Documentation Glossary

A glossary of terms for those who anticipate developing documentation for OpenSpace.

CommonMark

A standard syntax of Markdown that is used across many communities and projects.

MyST

A flavour of Markdown that was designed for use with the Sphinx project. It is a combination of CommonMark Markdown and a few extra syntax pieces to support features of Sphinx, so that you can write Sphinx documentation in plain Markdown.

Sphinx

A documentation engine written in Python. Sphinx supports many features that are necessary for scientific and scholarly publishing.