matplotlib.sphinxext.plot_directive#

Uma diretiva para incluir um gráfico Matplotlib em um documento Sphinx #

Por padrão, na saída HTML, plotincluirá um arquivo .png com um link para .png e .pdf de alta resolução. Na saída LaTeX, incluirá um arquivo .pdf.

O código-fonte do gráfico pode ser incluído de três maneiras:

  1. Um caminho para um arquivo de origem como argumento para a diretiva:

    .. plot:: path/to/plot.py

    Quando um caminho para um arquivo de origem é fornecido, o conteúdo da diretiva pode opcionalmente conter uma legenda para o gráfico:

    .. plot:: path/to/plot.py

   The plot caption.

    Além disso, pode-se especificar o nome de uma função a ser chamada (sem argumentos) imediatamente após a importação do módulo:

    .. plot:: path/to/plot.py plot_function1

  2. Incluído como conteúdo inline para a diretiva:

    .. plot::

   import matplotlib.pyplot as plt
   import matplotlib.image as mpimg
   import numpy as np
   img = mpimg.imread('_static/stinkbug.png')
   imgplot = plt.imshow(img)

  3. Usando a sintaxe doctest :

    .. plot::

   A plotting example:
   >>> import matplotlib.pyplot as plt
   >>> plt.plot([1, 2, 3], [4, 5, 6])

Opções #

A plotdiretiva suporta as seguintes opções:

formato {'python', 'doctest'}

O formato da entrada. Se não definido, o formato é detectado automaticamente.

include-source bool

Se o código-fonte deve ser exibido. O padrão pode ser alterado usando a plot_include_sourcevariável in conf.py(que tem como padrão False).

codificação str

Se este arquivo de origem estiver em uma codificação não UTF8 ou não ASCII, a codificação deverá ser especificada usando a :encoding:opção. A codificação não será inferida usando o metacomentário.-*- coding -*-

contexto bool ou str

Se fornecido, o código será executado no contexto de todas as diretivas de enredo anteriores para as quais a :context:opção foi especificada. Isso se aplica apenas a diretivas de plotagem de código em linha, não àquelas executadas a partir de arquivos. Se a opção for especificada, o contexto é redefinido para este e futuros gráficos, e as figuras anteriores são fechadas antes de executar o código. mantém o contexto, mas fecha as figuras anteriores antes de executar o código.:context: reset:context: close-figs

nofigs bool

Se especificado, o bloco de código será executado, mas nenhuma figura será inserida. Isso geralmente é útil com a :context:opção.

legenda str

Se especificado, o argumento da opção será usado como legenda da figura. Isso substitui a legenda fornecida no conteúdo, quando o gráfico é gerado a partir de um arquivo.

Além disso, esta diretiva suporta todas as opções da image diretiva, exceto o alvo (já que plot adicionará seu próprio alvo). Estes incluem alt , height , width , scale , align e class .

Opções de configuração #

A diretiva plot tem as seguintes opções de configuração:

plot_include_source

Valor padrão para a opção include-source (padrão: False).

plot_html_show_source_link

Se deve mostrar um link para a fonte em HTML (padrão: True).

plot_pre_code

Código que deve ser executado antes de cada plotagem. Se None (o padrão), o padrão será uma string contendo:

import numpy as np
from matplotlib import pyplot as plt
plot_basedir

Diretório base, ao qual plot::os nomes de arquivo são relativos. Se Nenhum ou vazio (o padrão), os nomes dos arquivos são relativos ao diretório onde está o arquivo que contém a diretiva.

plot_formats

Formatos de arquivo a serem gerados (padrão: ['png', 'hires.png', 'pdf']). Lista de tuplas ou strings:

[(suffix, dpi), suffix, ...]

que determinam o formato do arquivo e o DPI. Para entradas cujo DPI foi omitido, são escolhidos padrões sensatos. Ao passar da linha de comando por sphinx_build a lista deve ser passada como suffix:dpi,suffix:dpi, ...

plot_html_show_formats

Se os links para os arquivos devem ser exibidos em HTML (padrão: True).

plot_rcparams

Um dicionário contendo qualquer rcParams não padrão que deve ser aplicado antes de cada gráfico (padrão: {}).

plot_apply_rcparams

Por padrão, rcParams são aplicados quando a :context:opção não é usada em uma diretiva de plotagem. Se definida, essa opção de configuração substitui esse comportamento e aplica rcParams antes de cada plotagem.

plot_working_directory

Por padrão, o diretório de trabalho será alterado para o diretório do exemplo, para que o código possa acessar seus arquivos de dados, se houver. Além disso, seu caminho será adicionado para sys.pathque ele possa importar quaisquer módulos auxiliares ao lado dele. Esta opção de configuração pode ser usada para especificar um diretório central (também adicionado a sys.path) onde os arquivos de dados e módulos auxiliares para todos os códigos estão localizados.

plot_template

Forneça um modelo personalizado para preparar o texto reestruturado.

classe matplotlib.sphinxext.plot_directive. PlotDirective ( nome , argumentos , opções , conteúdo , lineno , content_offset , block_text , estado , state_machine ) [fonte] #

A diretiva, conforme documentado no docstring do módulo... plot::

final_argument_whitespace = Falso #

O argumento final pode conter espaços em branco?

has_content = Verdadeiro #

A diretiva pode ter conteúdo?

option_spec = {'align': <função Image.align>, 'alt': <função inalterada>, 'caption': <função inalterada>, 'class': <função class_option>, 'contexto': <função _option_context>, 'encoding': <function _deprecated_option_encoding>, 'format': <function _option_format>, 'height': <função length_or_unitless>, 'include-source': <function _option_boolean>, 'nofigs': <sinalizador de função>, 'escala': <função nonnegative_int>, 'width': <função length_or_percentage_or_unitless>} #

Mapeamento de nomes de opções para funções do validador.

argumentos_opcionais = 2 #

Número de argumentos opcionais após os argumentos obrigatórios.

argumentos_necessários = 0 #

Número de argumentos de diretiva necessários.

executar ( ) [fonte] #

Execute a diretiva plot.

exceção matplotlib.sphinxext.plot_directive. PlotError [fonte] #
matplotlib.sphinxext.plot_directive. mark_plot_labels ( aplicativo , documento ) [fonte] #

Para tornar os gráficos referenciados, precisamos mover a referência do nó "htmlonly" (ou "latexonly") para o próprio nó da figura real.

matplotlib.sphinxext.plot_directive. out_of_date ( original , derivado , includes = None ) [source] #

Retorna se derivado está desatualizado em relação ao original ou a qualquer um dos arquivos RST incluídos nele usando a diretiva RST include ( includes ). derivado e original são caminhos completos, e includes é opcionalmente uma lista de caminhos completos que podem ter sido incluídos no arquivo .

matplotlib.sphinxext.plot_directive. render_figures ( code , code_path , output_dir , output_base , context , function_name , config , context_reset = False , close_figs = False , code_includes = None ) [fonte] #

Execute um script pyplot e salve as imagens em output_dir .

Salve as imagens em output_dir com nomes de arquivo derivados de output_base

matplotlib.sphinxext.plot_directive. run_code ( code , code_path , ns = None , function_name = None ) [fonte] #

[ Obsoleto ] Importe um módulo Python de um caminho e execute a função fornecida por name, se function_name não for None.

Notas

Obsoleto desde a versão 3.5.

matplotlib.sphinxext.plot_directive. split_code_at_show ( texto ) [fonte] #

[ Obsoleto ] Código dividido em plt.show ().

Notas

Obsoleto desde a versão 3.5.

matplotlib.sphinxext.plot_directive. unescape_doctest ( texto ) [fonte] #

[ Obsoleto ] Extraia o código de um pedaço de texto, que contém código Python ou doctests.

Notas

Obsoleto desde a versão 3.5: em vez disso, use doctest.script_from_examples.