matplotlib.sphinxext.roles

Пользовательские роли для документации Matplotlib.

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

Эти роли считаются полуофициальными. Они предназначены только для использования в документации Matplotlib.

Однако downstream-пакеты могут включить эти роли в свою документацию, что приведёт к ошибкам при сборке документации. Далее описаны точный механизм возникновения ошибок и способы их устранения.

Есть два способа, которыми строки документации Matplotlib могут попасть в документацию downstream-пакетов. Необходимо создать подкласс класса Matplotlib и либо использовать параметр :inherited-members: в конфигурации autodoc, либо переопределить метод, не задавая для него новую строку документации; новый метод унаследует исходную строку документации и по-прежнему будет отображаться в autodoc. Если строка документации содержит одну из пользовательских ролей Sphinx, вы увидите одно из следующих сообщений об ошибке:

Unknown interpreted text role "mpltype".
Unknown interpreted text role "rc".

Чтобы исправить это, добавьте этот модуль в качестве расширения в conf.py Sphinx:

extensions = [
    'matplotlib.sphinxext.roles',
    # Other extensions.
]

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

Прямое использование этих ролей в других пакетах официально не поддерживается. Мы оставляем за собой право изменять или удалять эти роли без предварительного уведомления.

matplotlib.sphinxext.roles._mpltype_role(name, rawtext, text, lineno, inliner, options=None, content=None)[исходный код]

Роль Sphinx :mpltype: для пользовательских типов Matplotlib.

В Matplotlib существует ряд понятий, похожих на типы, но не имеющих прямого представления в виде типа; например, цвет. Эта роль позволяет правильно выделять их в документации и создавать ссылки на их определения.

Поддерживаемые в настоящее время значения:

:mpltype:`color` будет отображаться как: цвет

matplotlib.sphinxext.roles._rcparam_role(name, rawtext, text, lineno, inliner, options=None, content=None)[исходный код]

Роль Sphinx :rc: для выделения записей rcParams и создания на них ссылок.

Использование: укажите требуемый ключ rcParams в качестве параметра.

:rc:`figure.dpi` будет отображаться как: rcParams["figure.dpi"] (по умолчанию: 100.0)