MyST#

Sabueso’s admonitions#

The following admonitions are suggested to be used in Sabueso’s documentation

Did you know…?#

This kind of messages includes “academic” information related with a topic mentioned in the documentation. The content will not be about Sabueso’s syntax, methods, or use, but with scientific comments which might be useful to understand the context or enrich the users’ culture.

Given that these messages are not ‘essential’ to follow the documentation, their text will not be shown by default. The box can be unfolded using the “Click to show” button on the right.

```{admonition} Did you know...?
:class: tip, dropdown
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

Did you know…?

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

See also#

The “See also” messages are used in Sabueso to report those classes, methods, attributes from Sabueso’s API, or those sections of Sabueso’s documentations, the reader should check at the end of a section.

The “See also” message must be explicitly shown in the documentation (Do not use the ‘dropdown’ option):

```{admonition} See also
:class: attention
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

See also

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Note#

The “Note” messages are used to include notes to the main text in the documentation. These notes could be, for instance, …

Notes shouldn’t be skipped by the reader. Please do not use the ‘dropdown’ option.

```{admonition} Note
:class: note
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

Note

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Warning#

Use the “Warning” boxes to communicate messages the users should know to avoid errors, the missuse of sabueso’s classes, methods and attributes, or the missinterpretations of Sabueso’s output.

These messages must be read by every user. Please do not use the ‘dropdown’ option.

```{admonition} Warning
:class: danger
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

Warning

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Default MyST admonitions#

Feel free to use other admonitions. And, if you think they should be frequently used in Sabueso’s documentation, feel free to suggest their inclusion in the above section.

The following is a just a list of what we think are the default MyST admonition.

Note#

```{note}
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

Note

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

See also#

```{seealso}
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

See also

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Attention#

```{attention}
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

Attention

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Caution#

```{caution}
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

Caution

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

To do#

```{todo}
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

Todo

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Warning#

```{warning}
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

Warning

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Hint#

```{hint}
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

Hint

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Important#

```{important}
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

Important

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Tip#

```{tip}
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

Tip

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Danger#

```{danger}
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

Danger

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Error#

```{error}
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
```

Error

Lorem ipsum dolor sit amet, consectetur adipiscing elit.