Примечания#

Директива admonition#

Базовый синтаксис директивы:

```{admonition}
Общее примечание `admonition`.
```

Общее примечание admonition.

```{admonition} Заголовок
Примечание `admonition` с заголовком.
```

Заголовок

Примечание admonition с заголовком.

Производные примечания#

Данные примечания можно использовать через собственное название директивы, либо через опцию :class: директивы admonition.

note#

```{note}
Примечание `note`.
```

Примечание

Примечание note.

```{admonition} Примечание
:class: note

Примечание `note`.
```

Примечание

Примечание note.

seealso#

```{seealso}
Примечание `seealso`.
```

См. также

Примечание seealso.

```{admonition} См.также
:class: seealso

Примечание `seealso`.
```

См.также

Примечание seealso.

tip#

```{tip}
Примечание `tip`.
```

Совет

Примечание tip.

```{admonition} Совет
:class: tip

Примечание `tip`.
```

Совет

Примечание tip.

hint#

```{hint}
Примечание `hint`.
```

Подсказка

Примечание hint.

```{admonition} Подсказка
:class: hint

Примечание `hint`.
```

Подсказка

Примечание hint.

important#

```{important}
Примечание `important`.
```

Важно

Примечание important.

```{admonition} Важно
:class: important

Примечание `important`.
```

Важно

Примечание important.

attention#

```{attention}
Примечание `attention`.
```

Внимание

Примечание attention.

```{admonition} Внимание
:class: attention

Примечание `attention`.
```

Внимание

Примечание attention.

caution#

```{caution}
Примечание `caution`.
```

Осторожно

Примечание caution.

```{admonition} Осторожно
:class: caution

Примечание `caution`.
```

Осторожно

Примечание caution.

warning#

```{warning}
Примечание `warning`.
```

Предупреждение

Примечание warning.

```{admonition} Предупреждение
:class: warning

Примечание `warning`.
```

Предупреждение

Примечание warning.

danger#

```{danger}
Примечание `danger`.
```

Опасно

Примечание danger.

```{admonition} Опасно
:class: danger

Примечание `danger`.
```

Опасно

Примечание danger.

error#

```{error}
Примечание `error`.
```

Ошибка

Примечание error.

```{admonition} Ошибка
:class: error

Примечание `error`.
```

Ошибка

Примечание error.

info#

```{info}
Примечание `info`.
```

Info

Примечание info.

```{admonition} Info
:class: info

Примечание `info`.
```

Info

Примечание info.

abstract#

```{abstract}
Примечание `abstract`.
```

Abstract

Примечание abstract.

```{admonition} Abstract
:class: abstract

Примечание `abstract`.
```

Abstract

Примечание abstract.

success#

```{success}
Примечание `success`.
```

Success

Примечание success.

```{admonition} Success
:class: success

Примечание `success`.
```

Success

Примечание success.

question#

```{question}
Примечание `question`.
```

Question

Примечание question.

```{admonition} Question
:class: question

Примечание `question`.
```

Question

Примечание question.

failure#

```{failure}
Примечание `failure`.
```

Failure

Примечание failure.

```{admonition} Failure
:class: failure

Примечание `failure`.
```

Failure

Примечание failure.

bug#

```{bug}
Примечание `bug`.
```

Bug

Примечание bug.

```{admonition} Bug
:class: bug

Примечание `bug`.
```

Bug

Примечание bug.

example#

```{example}
Примечание `example`.
```

Пример

Примечание example.

```{admonition} Пример
:class: example

Примечание `example`.
```

Пример

Примечание example.

quote#

```{quote}
Примечание `quote`.
```

Quote

Примечание quote.

```{admonition} Quote
:class: quote

Примечание `quote`.
```

Quote

Примечание quote.

Опции#

Перечисленные ниже опции доступны для всех примечаний.

:title:#

С помощью данной опции можно указать альтернативный заголовок для примечания. Если заголовок указан в аргументе директивы, то это значение будет объединено со значением опции.

```{hint}
Примечание `hint`.
```

Подсказка

Примечание hint.

```{hint}
:title: Альтернативный заголовок

Примечание `hint` с альтернативным заголовком.
```

Альтернативный заголовок

Примечание hint с альтернативным заголовком.

```{admonition} Заголовок из аргумента
:title: Заголовок из опции

Примечание с объединенным заголовком.
```

Заголовок из аргумента Заголовок из опции

Примечание с объединенным заголовком.

:no-title:#

Данный флаг убирает отображение заголовока примечания. Эта опция вызовет такое же поведение, как у директивы admonition без предоставления аргумента.

```{success}
:no-title:

Примечание `success` без заголовка.
```

Примечание success без заголовка.

```{admonition}
Примечание `admonition` без заголовка.
```

Примечание admonition без заголовка.

:collapsible:#

Данный параметр можно использовать для преобразования отображаемого примечания в сворачиваемый элемент HTML <details>. Значение open сделает примечание развернутым по умолчанию. Любое другое значение игнорируется и сделает уведомление свернутым по умолчанию. Также см. описание директивы dropdown.

```{example} Открыто по умолчанию
:collapsible: open

Развернутое примечание.
```
Открыто по умолчанию

Развернутое примечание.

```{question} Свернуто по умолчанию
:collapsible:

Свернутое примечание.
```
Свернуто по умолчанию

Свернутое примечание.

:name:#

Данная опция устанавливает идентификатор для ссылки на примечание из других частей документации с помощью роли ref.

```{quote} Ссылка на примечание
:name: my-admonition

Ссылка на {ref}`это примечание <my-admonition>`
```

Ссылка на примечание

Ссылка на это примечание

:class:#

Данная опция используется для применения пользовательских стилей к примечанию. В директиве admonition ее можно использовать для выбора типа примечания.

```{admonition}
:class: danger

Примечание `danger`.
```

Примечание danger.

Для удобства есть директива dropdown, которая неявно является директивой admonition с уже установленным параметром :collapsible:.

Помимо основных опций, описанных выше, у dropdown есть еще :open:, которая раскрывает примечание.

```{dropdown}
Пример свернутого примечания.
```
Примечание

Пример свернутого примечания.

```{dropdown}
:open:

Пример развернутого примечания.
```
Примечание

Пример развернутого примечания.

```{dropdown}
:open:
:class: example

Пример свернутого примечания `example`.
```
Пример

Пример свернутого примечания example.