matplotlib.sphinxext.mathmpl#

Un rôle et une directive pour afficher mathtext dans Sphinx #

Avertissement

Dans la plupart des cas, vous voudrez probablement utiliser l'une des extensions mathématiques intégrées de Sphinx au lieu de celle-ci.

Mathtext peut être inclus de deux manières :

  1. Inline, en utilisant le rôle :

    This text uses inline math: :mathmpl:`\alpha > \beta`.

    qui produit :

    Ce texte utilise des mathématiques en ligne : .

  2. Autonome, en utilisant la directive :

    Here is some standalone math:

.. mathmpl::

    \alpha > \beta

    qui produit :

    Voici quelques calculs autonomes :

Option #

Le mathmplrôle et la directive prennent en charge les options suivantes :

fontset str, par défaut : 'cm'

Le jeu de polices à utiliser lors de l'affichage des mathématiques. Voir rcParams["mathtext.fontset"](par défaut : 'dejavusans').

taille de police flottante

La taille de la police, en points. Par défaut, la valeur de l'option de configuration d'extension définie ci-dessous.

Options de configuration #

L'extension mathtext a les options de configuration suivantes :

mathmpl_fontsize flottant, par défaut : 10.0

Taille de police par défaut, en points.

mathmpl_srcset liste de chaînes, par défaut : []

Tailles d'image supplémentaires à générer lors de l'intégration dans HTML, pour prendre en charge les images de résolution réactive . La liste doit contenir des descripteurs x supplémentaires ( '1.5x', '2x', etc.) à générer (1x est la valeur par défaut et est toujours inclus.)

classe matplotlib.sphinxext.mathmpl. MathDirective ( name , arguments , options , content , lineno , content_offset , block_text , state , state_machine ) [source] #

La directive, telle que documentée dans la docstring du module... mathmpl::

argument_final_espaceblanc = Faux #

L'argument final peut-il contenir des espaces ?

a_content = Vrai #

La directive peut-elle avoir un contenu ?

option_spec = {'fontset' : <function fontset_choice>, 'fontsize' : <function _make_type_validator.<locals>.validate_float_or_None>} #

Mappage des noms d'options aux fonctions de validation.

arguments_facultatifs = 0 #

Nombre d'arguments facultatifs après les arguments requis.

arguments_requis = 0 #

Nombre d'arguments de directive requis.