Documentation Guide

Documentation Guide#

This section is intended as a cheat sheet for working on the documentation of this package.

MyST#

Definition Lists#

Term 1

Definition

Term 2

Definition

Admonitions#

Note

Here is a note

Todo

Here is a todo

Warning

Here is a warning

Attention

Here is an attention

Caution

Here is a caution

Error

Here is an error

Tip

Here is a tip

Hint

Here is a hint

Important

Here is a important

Some title

Here is a admonition with a user-specific title.

Danger

Here is a danger

See also

Here is a seealso