On this page

• Admonitions
  • hint
  • note
  • important
  • tip
  • attention
  • caution
  • warning
  • danger
  • error
  • seealso
  • admonition
• Topics
  • topic
• Lifecycle
  • versionadded
  • versionchanged
  • deprecated

Informational

Admonitions

Admonitions are specially marked “topics” that can appear anywhere an ordinary body element can. They contain arbitrary body elements. Typically, an admonition is rendered as an offset block in a document, sometimes outlined or shaded, with a title matching the admonition type.

hint

Hint

This is how a hint admonition appears.

```{hint}
This is how a hint admonition appears.
```

note

Note

This is how an attention admonition appears.

```{note}
This is how a note admonition appears.
```

important

Important

This is how an important admonition appears.

```{important}
This is how an important admonition appears.
```

tip

Tip

This is how an tip admonition appears.

```{tip}
This is how an tip admonition appears.
```

attention

Attention

This is how an attention admonition appears.

```{attention}
This is how an attention admonition appears.
```

caution

Caution

This is how a caution admonition appears.

```{caution}
This is how a caution admonition appears.
```

warning

Warning

This is how a warning admonition appears.

```{warning}
This is how a warning admonition appears.
```

danger

Danger

This is how a danger admonition appears.

```{danger}
This is how a danger admonition appears.
```

error

Error

This is how an error admonition appears.

```{error}
This is how an error admonition appears.
```

seealso

Many sections include a list of references to module documentation or external documents. These lists are created using the seealso directive.

The seealso directive is typically placed in a section just before any subsections. For the HTML output, it is shown boxed off from the main flow of the text.

The content of the seealso directive should be a definition list.

See also

Module zipfile

Documentation of the zipfile standard module.

GNU tar manual, Basic Tar Format

Documentation for tar archive files, including GNU tar e tensions.

```{seealso}

Module {py:mod}`zipfile`
: Documentation of the {py:mod}`zipfile` standard module.

[GNU tar manual, Basic Tar Format](<http://link>)
: Documentation for tar archive files, including GNU tar e tensions.
```

admonition

Custom

This is how a generic admonition appears.

• The note contains all indented body elements following.

• It includes this bullet list.

```{admonition} Custom
This is how a generic admonition appears.

- The note contains all indented body elements
   following.
- It includes this bullet list.
```

Topics

A topic is like a block quote with a title, or a self-contained section with no subsections. Use the “topic” directive to indicate a self-contained idea that is separate from the flow of the document. Topics may occur anywhere a section or transition may occur. Body elements and topics may not contain nested topics.

topic

Topic Title

This is how a topic appears.

```{topic} Topic Title
This is how a topic appears.
```

Lifecycle

Lifecycle directives highlight changes related to methods.

versionadded

New in version 2.5: The spam parameter.

```{versionadded} 2.5
The *spam* parameter.
```

versionchanged

Changed in version 2.6: The spam parameter now accepts strings.

```{versionchanged} 2.6
The *spam* parameter now accepts strings.
```

deprecated

Deprecated since version 2.7: The spam parameter will be removed in a future version.

```{deprecated} 2.7
The *spam* parameter will be removed in a future version.
```