matplotlib.sphinxext.roles

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

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

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

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

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

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

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

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

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

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

matplotlib.sphinxext.roles._mpltype_role(name, rawtext, text, lineno, inliner, options=None, content=None)[source]

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

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

В настоящее время поддерживаются следующие значения:

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

matplotlib.sphinxext.roles._rcparam_role(name, rawtext, text, lineno, inliner, options=None, content=None)[source]

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

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

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