matplotlib.sphinxext.roles#

Benutzerdefinierte Rollen für die Matplotlib-Dokumentation.

Warnung

Diese Rollen gelten als semi-öffentlich. Sie sind nur für die Verwendung in der Matplotlib-Dokumentation bestimmt.

Es kann jedoch vorkommen, dass Downstream-Pakete diese Rollen in ihre Dokumentation übernehmen, was zu Fehlern beim Erstellen der Dokumentation führt. Das Folgende beschreibt den genauen Mechanismus und wie die Fehler behoben werden können.

Es gibt zwei Möglichkeiten, wie Matplotlib-Docstrings in der Dokumentation von Downstream-Paketen landen können. Sie müssen eine Matplotlib-Klasse unterklassieren und entweder die Option :inherited-members: in Ihrer Autodoc-Konfiguration verwenden oder eine Methode überschreiben, ohne eine neue Docstring anzugeben; die neue Methode erbt die ursprüngliche Docstring und wird trotzdem in Ihrer Autodoc gerendert. Wenn die Docstring eine der benutzerdefinierten Sphinx-Rollen enthält, sehen Sie eine der folgenden Fehlermeldungen

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

Um dies zu beheben, können Sie dieses Modul als Erweiterung zu Ihrer Sphinx-Datei conf.py hinzufügen

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

Warnung

Die direkte Verwendung dieser Rollen in anderen Paketen wird nicht offiziell unterstützt. Wir behalten uns das Recht vor, diese Rollen ohne vorherige Benachrichtigung zu ändern oder zu entfernen.

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

Sphinx-Rolle :mpltype: für benutzerdefinierte Matplotlib-Typen.

In Matplotlib gibt es eine Reihe von typähnlichen Konzepten, die keine direkte Typdarstellung haben; Beispiel: Farbe. Diese Rolle ermöglicht es, sie in der Dokumentation ordnungsgemäß hervorzuheben und auf ihre Definition zu verlinken.

Derzeit unterstützte Werte

  • :mpltype:`color` wird gerendert als: Farbe

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

Sphinx-Rolle :rc: zum Hervorheben und Verlinken von rcParams-Einträgen.

Verwendung: Geben Sie den gewünschten rcParams-Schlüssel als Parameter an.

:rc:`figure.dpi` wird gerendert als: rcParams["figure.dpi"] (Standard: 100.0)

Auf dieser Seite