matplotlib.sphinxext.plot_directive#

Sphinx 문서에 Matplotlib 플롯을 포함하기 위한 지시어 #

기본적으로 HTML 출력 plot에는 고해상도 .png 및 .pdf에 대한 링크가 있는 .png 파일이 포함됩니다. LaTeX 출력에는 .pdf가 포함됩니다.

플롯의 소스 코드는 다음 세 가지 방법 중 하나로 포함될 수 있습니다.

  1. 지시문에 대한 인수로 소스 파일의 경로 :

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

    소스 파일에 대한 경로가 제공되면 지시문의 내용에 플롯에 대한 캡션이 선택적으로 포함될 수 있습니다.

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

   The plot caption.

    또한 모듈을 가져온 직후에 호출할 함수의 이름(인수 없이)을 지정할 수 있습니다.

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

  2. 지시문에 인라인 콘텐츠 로 포함됨 :

    .. 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. doctest 구문 사용 :

    .. plot::

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

옵션 #

plot지시문은 다음 옵션을 지원합니다 .

형식 {'python', 'doctest'}

입력 형식입니다. 설정하지 않으면 형식이 자동으로 감지됩니다.

포함 소스 부울

소스 코드를 표시할지 여부입니다. plot_include_source기본값은 in 변수를 사용하여 변경할 수 있습니다 conf.py(기본값은 False임).

문자열 인코딩

이 소스 파일이 비 UTF8 또는 비 ASCII 인코딩인 경우 :encoding:옵션을 사용하여 인코딩을 지정해야 합니다. 인코딩은 메타 주석을 사용하여 유추되지 않습니다 .-*- coding -*-

컨텍스트 부울 또는 str

제공된 경우 코드는 :context:옵션이 지정된 모든 이전 플롯 지시문의 컨텍스트에서 실행됩니다. 이것은 인라인 코드 플롯 지시문에만 적용되며 파일에서 실행되는 지시문에는 적용되지 않습니다. 이 옵션을 지정하면 이 플롯과 향후 플롯에 대한 컨텍스트가 재설정되고 코드를 실행하기 전에 이전 그림이 닫힙니다. 컨텍스트를 유지하지만 코드를 실행하기 전에 이전 그림을 닫습니다.:context: reset:context: close-figs

nofigs 부울

지정된 경우 코드 블록이 실행되지만 그림은 삽입되지 않습니다. 이것은 일반적으로 :context:옵션과 함께 유용합니다.

캡션 문자열

지정된 경우 옵션의 인수가 그림의 캡션으로 사용됩니다. 이것은 플롯이 파일에서 생성될 때 내용에 제공된 캡션을 덮어씁니다.

또한 이 지시어는 targetimage 을 제외한 지시어 의 모든 옵션을 지원합니다 (plot은 자체 대상을 추가하므로). 여기에는 alt , height , width , scale , align 및 class 가 포함 됩니다.

구성 옵션 #

plot 지시문에는 다음과 같은 구성 옵션이 있습니다.

plot_include_source

include-source 옵션의 기본값(기본값: False).

plot_html_show_source_link

소스에 대한 링크를 HTML로 표시할지 여부(기본값: True).

plot_pre_code

각 플롯 전에 실행되어야 하는 코드. None(기본값)이면 기본적으로 다음을 포함하는 문자열이 됩니다.

import numpy as np
from matplotlib import pyplot as plt
plot_basedir

plot::파일 이름이 상대적인 기본 디렉토리 . None 또는 비어 있는 경우(기본값) 파일 이름은 지시문을 포함하는 파일이 있는 디렉토리에 상대적입니다.

plot_formats

생성할 파일 형식(기본값: ['png', 'hires.png', 'pdf']). 튜플 또는 문자열 목록:

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

파일 형식과 DPI를 결정합니다. DPI가 생략된 항목의 경우 합리적인 기본값이 선택됩니다. 명령줄에서 sphinx_build를 통해 전달할 때 목록은 suffix:dpi,suffix:dpi, ...로 전달되어야 합니다.

plot_html_show_formats

HTML 파일에 대한 링크를 표시할지 여부(기본값: True).

plot_rcparams

각 플롯 전에 적용해야 하는 비표준 rcParams를 포함하는 사전입니다(기본값: {}).

plot_apply_rcparams

기본적으로 rcParams는 :context:plot 지시문에서 옵션을 사용하지 않을 때 적용됩니다. 설정된 경우 이 구성 옵션은 이 동작을 재정의하고 각 플롯 전에 rcParams를 적용합니다.

plot_working_directory

기본적으로 작업 디렉토리는 예제의 디렉토리로 변경되므로 코드는 데이터 파일(있는 경우)을 가져올 수 있습니다. 또한 경로가 추가되어 sys.path옆에 있는 모든 도우미 모듈을 가져올 수 있습니다. sys.path이 구성 옵션을 사용하여 모든 코드에 대한 데이터 파일 및 도우미 모듈이 있는 중앙 디렉터리( 에도 추가됨)를 지정할 수 있습니다.

plot_template

재구성된 텍스트를 준비하기 위한 맞춤형 템플릿을 제공합니다.

클래스 matplotlib.sphinxext.plot_directive. PlotDirective ( name , arguments , options , content , lineno , content_offset , block_text , state , state_machine ) [소스] #

모듈의 docstring에 문서화된 지시문입니다 ... plot::

final_argument_whitespace = 거짓 #

마지막 인수에 공백이 포함될 수 있습니까?

has_content = 참 #

지시문에 내용이 있을 수 있습니까?

option_spec = {'정렬': <function Image.align>, 'alt': <함수 변경 안 됨>, '캡션': <함수 변경 안 됨>, '클래스': <함수 클래스 옵션>, '컨텍스트': <함수 _option_context>, 'encoding': <function _deprecated_option_encoding>, 'format': <function _option_format>, 'height': <function length_or_unitless>, 'include-source': <function _option_boolean>, 'nofigs': <함수 플래그>, '규모': <function nonnegative_int>, '너비': <function length_or_percentage_or_unitless>} #

유효성 검사기 기능에 대한 옵션 이름 매핑.

optional_arguments = 2 #

필수 인수 뒤의 선택적 인수 수입니다.

required_arguments = 0 #

필수 지시문 인수의 수입니다.

실행 ( ) [소스] #

플롯 지시문을 실행합니다.

예외 matplotlib.sphinxext.plot_directive. 플롯 오류 [출처] #
matplotlib.sphinxext.plot_directive. mark_plot_labels ( 앱 , 문서 ) [출처] #

플롯을 참조 가능하게 만들려면 "htmlonly"(또는 "latexonly") 노드에서 실제 그림 노드 자체로 참조를 이동해야 합니다.

matplotlib.sphinxext.plot_directive. out_of_date ( 원본 , 파생 , 포함 = 없음 ) [소스] #

RST 포함 지시문( 포함 )을 사용하여 파생된 파일이 원본 또는 포함된 RST 파일에 비해 오래된 것인지 여부를 반환합니다 . 파생 및 원본 은 전체 경로이고 포함 은 선택적으로 원본 에 포함되었을 수 있는 전체 경로 목록입니다 .

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 ) [소스] #

pyplot 스크립트를 실행하고 이미지를 output_dir 에 저장합니다 .

output_base 에서 파생된 파일 이름 으로 output_dir 아래에 이미지를 저장합니다.

matplotlib.sphinxext.plot_directive. run_code ( 코드 , code_path , ns = 없음 , function_name = 없음 ) [소스] #

[ Deprecated ] function_name이 None이 아닌 경우 경로에서 Python 모듈을 가져오고 이름으로 지정된 함수를 실행합니다.

메모

버전 3.5부터 사용되지 않습니다.

matplotlib.sphinxext.plot_directive. split_code_at_show ( 텍스트 ) [출처] #

[ Deprecated ] plt.show()에서 코드를 분할합니다.

메모

버전 3.5부터 사용되지 않습니다.

matplotlib.sphinxext.plot_directive. unescape_doctest ( 텍스트 ) [출처] #

[ Deprecated ] Python 코드 또는 doctest를 포함하는 텍스트 조각에서 코드를 추출합니다.

메모

버전 3.5부터 폐지됨: 대신 doctest.script_from_examples를 사용하십시오.