-Ph <dZddlZddlZddlZddlZddlZddlmZmZddlm Z ddl m Z ddlm Z ddl mZddlmZmZddlZdd lmZdd lmZmZdd lmZmZmZmZd d lmZ d dlm!Z!d dl"m#Z#d dl$m%Z%m&Z&m'Z'd dl(m)Z)d dl*m+Z+d dl,m-Z-m.Z.m/Z/m0Z0m1Z1d dl2m3Z3m4Z4m5Z5m6Z6m7Z7m8Z8d dl9m:Z:m;Z;d dlm?Z?d dl@mAZAmBZBmCZCmDZDmEZEmFZFmGZGmHZHmIZIdZJGddZKidejejLdzddd ejMNd!d"d#d$hd%id&d$hd'eKd(dd)d*d+dd,d-d.dd/d0d1eOd2id3d4d5d6id7d8d9d:d;d<d=d<d>d?d exclude_regexs r:)_update_gallery_conf_exclude_implicit_docrsV . /  388F<0F#GHHIIJJJ  2?L-...r<htmlcr||||||d<||d<dS)N)r])r`src_dir builder_nameupdate)sphinx_gallery_confrr]r`rs r:#_update_gallery_conf_builder_initedrsOL9996LMMM%, "*6'''r<ct|}tt|t|z }|r|rd}|D]j}t||d}|t|z }t |dkr|d|ddz }nt |dkr |d|dz }|d z }kt |d Sd S) zCCheck SG config keys, optionally raising if any extra keys present.z'Unknown key(s) in sphinx_gallery_conf: gQ?)cutoffrz, did you mean r?z, did you mean one of  N)rsetrreprlenr strip)r>r check_keysoptions extra_keysmsgkeys r:_check_extra_config_keysrs\""G/003w<<?@@J 'j '8  C'WTBBBG 499 C7||q  88888W!!<<<<< 4KCC#))++&&& ' ' ' 'r<cL||}t||s|r#|!|rt|tr|g||<dSdSd}t|tr|f}d|D}|rdnd}t|j} ||||| }t |)zFCheck config type, optionally converting str to list or allowing None.NzE'{conf_key}' config allowed types: {types}{or_none}. Got {conf_type}.cg|] }|j Sr8)rA).0ts r: z&_check_config_type..s++++++r<z or Noner\)conf_keytypesor_none conf_type)rrtyperAformatr ) r>rr str_to_list allow_none conf_valuer str_typesrrs r:_check_config_typersh'J*e$$ 8J  *c** 6*4 X& F QC%++U+++I&.jjBGZ  )I **   C c  r<cjt|dttfdt}|dD]b}t |t r|dddkst d|d|t|ddc|d hz}gt||d<dS) z?Check `_check_image_srcset`, convert to float and removing '1'.rTrNrz*Invalid value for image_srcset parameter: ze. Must be a list of strings with the multiplicative factor followed by an "x". e.g. ["2.0x", "1.5x"]r) rlisttuplerrrr addfloatr)r>srcset_mult_facssts r:_check_image_srcsetrs|^dE]PTUUUUuu>*--2s## 2333DRDDD  U2crc7^^,,,,#>V,<%=%=#>L   r<c.t|dtttfd|dtd}t}t D]I\}}||vr@|dr||4td|d|Jfd|d d d D}tr>ts0t d d d |d<||d<d S)z7Check `compress_images`, getting any command line args.rrTr)images thumbnails-z.All entries in compress_images must be one of z1 or a command-line switch starting with "-", got c:g|]}|Sr8)pop)rprrs r:rz*_check_compress_images..s'GGGqO//22GGGr<Nrz8optipng binaries not found, PNG %s will not be optimizedz and r8compress_images_args) rrrr enumerate startswithappendr rr/loggerrr)r>allowed_valuespopskikindrrrs @r:_check_compress_imagesrsd eT  ##45O?++O-N 66Do..  D ~ % %s##  B3!33*.33  &HGGGD2JGGG ?LNN F LL ) )   &5L"#+?L'(((r<c|d}t|tr|f}d}t|dvrt|dx}tstd|t|dkrq|d}|gt|tstd|dvr?|= |d n&#t $r}td |d |d}~wwxYw||f|d<dS) z%Check `matplotlib_animations` config.rN)rrzS'matplotlib_animations' must be a single bool or (enabled: bool, format: str), not rz<'matplotlib_animations' file format must be a string or None)html5jshtmlzsphinxcontrib.videoz/'matplotlib_animations' specifies file format: z0; this requires the sphinxcontrib.video package.)rrrr rsetup_extensionr)r>app animationsfmtenabledes r:_check_matplotlib_animationsr"sZ56J*d## ]   OOv % %* 1 5MWt*T*T % @1; @ @    :m ?c3'' !R---?!++,ABBBB)!!!)NcNNN !!! .5cNL()))s+C C$ CC$c,|d}t|dttf|durtn||d<t\}}t |dtr"| t dd|d<nQt |dtrt d|nt dt |tr!d}|D]}||vrtd |d |d dSdS) zCheck `pypandoc` config.rzTNzg'pypandoc' not available. Using Sphinx-Gallery to convert rst text blocks to markdown for .ipynb files.FzPUsing pandoc version: %s to convert rst text blocks to markdown for .ipynb fileszMUsing Sphinx-Gallery to convert rst text blocks to markdown for .ipynb files.) extra_argsfiltersz2'pypandoc' only accepts the following key values: , got: .) rdictrr0rrrinfor )r>rz has_pypandocversion accepted_keysrs r:_check_pypandoc_configrEslJ'H|Z$>>>)1T)9)9tvvvxL)OOL',z*D11 l6J D   $) Z  L,d 3 3    (       )   (D!!1   C-''!<,<<58<<<(  r<ctjt}t|||||dD]}t ||||<d|d<ddi|d<|U|jdr|jd|d<|jd|d<t|dtr |ddi|d<t|dttfd gd }|dD]}||vrtd |d |t|dtt|dttf|dd ur |j|d<|ddkrd|d<|dr# ddl}n#t"$rt%dwxYwt'|d dD]!}|dkr ||t)||" t+n#t,t$f$rYnwxYwt/|t1|t3||t)|dt|dt|ddvrtd|dd}|D]} t|| td t5|i|d<t|dtt6jfd |d} t| t6jrt| |d<t;|d|d<t=|d ||d <t|d!ttfd |d!D]?} | t>vrtd"| d#t>|| | d$z@t|d%tt|d&ts$|d&d'krtd(|d&t)|d)d*tC||S)+zEHandle user configs, update default gallery configs and check values.)rorgr\ default_rolez.rstrestructuredtext source_suffixNrYTr)r;__str__rZz-All entries in 'capture_repr' must be one of rr[rrFrz7joblib must be importable when parallel mode is enabledr)rprNrRrsrRrsru)rvafterbothz?reset_modules_order must be in['before', 'after', 'both'], got )rwrx)rtitlesrUrmrnrz Unknown css z, must be one of z.cssrrunusedzDgallery_conf["show_api_usage"] must be True, False or "unused", got rPr)"copydeepcopyDEFAULT_GALLERY_CONFrrrconfigrrrrrr rintrjoblib Exception ValueErrorrrr) ImportErrorrrrrpathlibrr!r" _KNOWN_CSS add_css_filer) rrrr>rsupported_reprsreprcell_config_keysrbackrefrs r:_fill_gallery_conf_defaultsrgs*=!566L\+> KKK+,,,::'|C'899 S#%L %+-?$@L!  :n % F+.:n+EL ((+ ?(C _% l?3S 9 9 R-9/-JD,QL )|^eT]PTUUUU<<>>|Z$===J4''#&< Z J1$$#( Z JX X MMMM X X XVWW W Xl48888** * * *|C/@/H |S))))   $      %%%<((( s333<111|%:C@@@)*2MMM ; 56 ; ;   E$II<34HHHHH<(((L gl /0G'7<((:-0\\ )*/|H/EFFL#9]# ##L |UT5MtLLLLE"++ j SSSSZSSTT T ?   S6\ * * *|%7=== |$45t < < ) *h 6 6 4 01 4 4   /.l;;; s(E--FGG#"G#c dd}nNd}t|trt|d<t d\}dt jD|rfdDnfdDt j|fdD t |}fd fd |DDS) aReturn the list of subsections of a gallery. Parameters ---------- srcdir : str absolute path to directory containing conf.py examples_dir : str path to the examples directory relative to conf.py gallery_conf : Dict[str, Any] Sphinx-Gallery configuration dictionary. check_for_header : bool only return subfolders that contain a GALLERY_HEADER file, default True Returns ------- out : list sorted list of gallery subsection folder names rONcg|]}|Sr8r8)r subfolders r:rz#get_subsections..sFFF )FFFr<cvg|]5}ttj|d 3|6S)F) raise_error)rospathr)rr examples_dirr>s r:rz#get_subsections..s]   " \955|QV r<cg|]G}|dktjtj|E|HS) __pycache__)rrisdirr)rrrs r:rz#get_subsections..'sV   ]**GMM"',,|Y"G"GHH+ +**r<cPg|]"}tj|#Sr8rrr)ritembase_examples_dir_paths r:rz#get_subsections..1s77; +T22r<rc g|] }| Sr8r8)ri subfolderss r:rz#get_subsections..6s-     1    r<c:g|]}|Sr8)index)rrsubfolders_with_paths r:rz#get_subsections..8s(QQQt&,,T22QQQr<) getrrr*rrlistdirrrelpathr) srcdirrr>check_for_headersortkey subsec_ordersorted_subfoldersrr#r&s `` @@@r:get_subsectionsr/s{&&'/#''(:;; lD ) ) K/<\/J/JL+ ,#L2DEE FFRZ -E-EFFFJ      '       '    W__\6BB?I3AAA    QQQQ?PQQQ   r<c|d}|d}t|ts|g}t|ts|g}t|t|krtdt |drr*rHrSrUs r:_prepare_sphx_glr_dirsr5<s 1M/L mT * *(& lD ) )&$~  =S.... /    L- .//7W\\&,?S2TUU &6666 M<00 1 11r<czddfd|Ddgz}|S)z0Filter out tags from `subsection_index_content`.z^\.\.(\s+)\_(.+)\:(\s*)$rc>g|]}tj||SN)rmatch)rline tag_regexs r:rz _filter_tags..Xs5   x 4((0 000r<r\)r splitlines)subsection_index_contentr;s @r: _filter_tagsr>Tsb+I#yy    0;;==   $     $#r<c|r3|ddur)t|dkrt|d}||z }|dr"t||jj|}|r||z }|r|jjdr |tz }tj |d}tj |dd 5} | |d d d n #1swxYwYt|d d Sd S)zEAdd toctree, download and signature, if req, to index and write file.rTr) includehiddenr_r}z index.rst.newwutf-8encodingNrmode)rr-rbuilderr*rrrrrrcodecsopenwriter2) rr>indexst sg_root_indexsubsection_index_filesgallery_dir_abs_pathsubsections_toctreedownload_fhindex index_rst_newfhindexs r:_finish_index_rstrSbsr ' * +t 3 3 & ' '! + +- "$    &&+,(, #+"4l    ( ' 'G. : )*: ; $ | #G %9?KK [g > > > #' MM' " " " # # # # # # # # # # # # # # #]------..s5CCCc  |ddr] ddl}n#t$rtdwxYwtj|d}|d|ddt d i|}g}|g|z}|D]}tj || tdt  Dt|d d } | fd | Dtt!j|}|||D]} t'|| |dSdS) z,Build recommender and write recommendations.rbrcrNz*gallery_conf['recommender'] requires numpy rubric_headerc(g|]}|jdk |S)rK)suffix)rfnames r:rz&_build_recommender..s$UUU5u|u?T?T?T?T?Tr<rPr cPg|]"}tj|#Sr8r)rrXrs r:rz&_build_recommender..s)DDD%gu--DDDr<r8)numpyrr rrrr'rrrrriterdirrrrr from_iterablefitr() r>rNsubsecsnprecommender_paramsrbgallery_py_filesgallery_directories current_dirpy_filesrXrs @r:_build_recommenderresM"8,E L      L L LJKK K L"]< +FGGx(((555(>>+=>> 34w>.  Kgll#7EEGVUDMM$9$9$;$;UUU"<1JGTTUVW H  # #DDDD8DDD      34D E EFF()))% E EE ";| D D D D?EE< E Es1c"tddt||dd\}}|D]\}}}d|d|d d z}| |d z }t|Jt |d }||d krW|||ddz||dzz }t|d S)zLog computation time.zcomputation time summary:whitecolorrconsolerrz - z: r Nz (not run)rjrz r)rr_format_for_writingljustrsplitrjust) costsr>lineslensnamermtextt_floats r: _log_costsrxs KK+7K;;;% |I.YKE4 " " a####**47R<88 9 K D KK    AGGIIaL))G,':;;;Q((50177473C3CCC D!!! " "r<c |jj}d}|dr d|dd}td|ddt }g}t ||jj}d |D}t||d i}|D]>\}} tj |jj|} tj |jj| } t| | ||d \} } }}}t||| du}||z }t|| |d}|r,d| z}t|dkrt!|}||z }g}t#|jj| ||}|D](}tj | |}tj | |}|d d| |dgtjdt||||\}}}}}t||d }|r|t+|z }d }|r0|ds(t|dkrt!|}||z }n|rt-|d||z }t|||*t/|||||| t1|| |@t|d||dr+t3t5|d|dd||dd urt7|jjt9|||dr-t;||t=||jj|dSdS)aGenerate the Main examples gallery reStructuredText. Fill Sphinx-Gallery configuration and scan example directories (up to one level depth of sub-directory) to generate example reST files. Iterate through each example directory and any of its sub-directories (creates sub-sections) that has a header/index file. Generate gallery example ReST files and `index.rst` file(s). If `nested_sections=True` we generate `index.rst` files for all sub-directories, which includes toctree linking to all sub-dir examples. The root example directory `index.rst` file will contain, in sequence,: * root gallery header then thumbnails, * toctree linking all examples in root gallery, * sub-section header followed by sub-section thumbnails, for all subsections, * a second final toctree, at the end of the file, linking to all sub-section index files. If `nested_sections=True` we generate a single `index.rst` file per example directory. It will contain headers for the root gallery and each sub-section, with each header followed by a toctree linking to every example in the root gallery/sub-section. r\rz (with parallel=)zgenerating galleryz...rgrhcg|]\}}|Sr8r8)rex_dir_s r:rz(generate_gallery_rst..s666 V666r<T)check_filenamesF) is_subsectionNz :orphan: r)r+/z index.rstrrrErUrbackreferences_allrr]) rrrrrr5rGr*r+rrrr r,rkrr-r/rreplacesepr>r2rSrer3r_init_api_usagerrxwrite_junit_xmloutdir) rr>extra seen_backrefsrqworkdirsrH backrefs_allr gallery_direxamples_dir_abs_pathrNr} this_content this_coststhis_toctree_items backrefs_rootrLrK this_toctreerMr^ subsectionr target_dirsubsection_index_pathr=subsection_costssubsection_toctree_filenamesbackrefs_subsechas_subsection_headersubsection_index_toctrees r:generate_gallery_rstrs`2:1L EJ?>< #;>>> KK/U///wK???EEM E%lCK4FGGH76X666M=,MMMML%-bHbH! k " S[-? N N!w||CK,> LL  !           m<<<%D0   .BJOOO  ($|3G%&&**./ABB <'"$! K  ! *     "' P' PJgll#8*EEG&:JGGJ " ) )"k:{CDDLLFC   !*lMRR  %( , $L/ B B B$) !' -<(@AAA(,% >$%67 >45599+:;W+X+X(33' >2==== % %E #L*>N O O O O      "     <)=wGGGGL$666()  Y'12$       $%U22 *+++]L999N#A5,''' ck&8%@@@@@AAr<z :orphan: .. _{0}: z% Computation times ================= c tdddt|z}d|jdz|jz|jt t|jdz }|S)z>Convert a number of seconds to a more readable representation.r)secondsz{:02d}:{:02d}.{:03d}<g@@) rrrhourminutesecondrround microsecond)rs r:_sec_to_readablervsn AqIa0000A%%  ah#eAMF4J.K.K*L*L  A Hr<c4|d |d |dfS)zCost sorting function.rmemsrc_filer8)costs r: _cost_keyrs"#YJe d:&6 77r<rst)rct}t|tD]}|d}tj||}|dvrtj|d|tjd}|dkr|ntj|}d |tj||} t|d} n|d ksJ|} |dd d } |d d d} | | | | g dtd|DD} || fS)aProvide formatted computation summary text. Parameters ---------- costs: List[Dict] List of dicts of computation costs and paths, see gen_rst.py for details. src_dir : pathlib.Path The Sphinx source directory. kind: 'rst', 'rst-full' or 'console', default='rst' Format for printing to 'console' or for writing `sg_execution_times.rst' ('rst' for single galleries and 'rst-full' for all galleries). Returns ------- lines: List[List[str]] Formatted computation text for each example, of format: [example_file, time_elapsed, memory_used] lens: List[int] Character length of each string in `lines`. r r)rrst-fullrr}rz!:ref:`sphx_glr_{0}_{1}` (``{2}``)rrjz0.2fz secrz.1fz MBc,g|]}t|Sr8)max)rrs r:rz'_format_for_writing..s S S SqCFF S S Sr<c&g|]}d|DS)c,g|]}t|Sr8)r)rrs r:rz2_format_for_writing...s">">">3t99">">">r<r8rrs r:rz'_format_for_writing..s'!Q!Q!Q4">">">">">!Q!Q!Qr<) rrrrrr)rrbasenamerrrr4) rqrrrrrrrel_pathtarget_dir_cleanparenrtrrurss r:rmrmsx, FFEu),,,## #7??8W55 & & &!wtL/A7KKSS   !% 2 2HH8H8H8R8RE6== "'"2"28"<"z*write_computation_times..s&114T#Y111111r<rz all galleriesrr\rr} sphx_glr_sg_execution_timeszsg_execution_times.rstrrArBrCz**z** total execution time for z filersz **from z**: rkaN.. container:: .. raw:: html .. list-table:: :header-rows: 1 :class: table table-striped sg-datatable * - Example - Time - Mem (MB) )N/Arrz * - z - )maxsplitr)sumrrr)rrris_filerIrJSPHX_GLR_COMP_TIMESrrrrmrsplit)r>rrq total_timeout_dirwherer ref_extranew_refout_filefidrrrsexrmbs r:rkrks 1 211511111Jy)  L,CDD}}RVS11444 7)777GG}}77HjAoo sW - -1 %,,W55666  W!*-- W W5zz W W'*5zzQB W WHM W W W   *  +   t      :9#8#8#8"9  IB2 II   1 a      U111111111111111111s C7GGGcD|jjddurdSd|jjvrt|jjd<||jjdvr!t|jjd|<|jjd||dS)aWrite api entries to `_sg_api_entries` configuration. To connect to `autodoc-process-docstring` event. Parameters ---------- app : The Sphinx application object. what: str The type of the object which the docstring belongs to. One of "module", "class", "exception", "function", "method", "attribute". name : The fully qualified name of the object. obj : The object itself. options : The options given to the directive: an object with attributes inherited_members, undoc_members, show_inheritance and no-index that are true if the flag option of same name was given to the auto directive. lines : The lines of the docstring, see above. rFN_sg_api_entries)rrrrr)rwhatrtobjrrrs r:write_api_entriesrs. z%&675@@ >>><@FF &'89 3:12CDDDBE%% &'89$?J"#45d;??EEEEEr<ctjtj|ddd5 ddddS#1swxYwYdS)Nsg_api_usage.rstrArBrC)rHrIrrr)rs r:rr's   ["455sW                        sAA  A z #00000080z #98CAE180z #FEDA8B80z #F67E4B80z #A5002680)edgeokaybad_1bad_2bad_3c tddl}||dddtdddd d d  }t|trKt }t }d |D}t|tD]ttdz D]^}||dzf|vr| ||dzf||vr||n|} | | |dz} t } tdz |krd} |D]Jt|dzkrtfdt|dzDr| dz } K| d| dz } | ||dz<| dkrd} n | dkrd} nd} t| | d<|j | fi| | | | td`|ddgD]k}|dttdz D]4}|dz|vr%| ||dz5lnt|t sJ|D]d\}}| ||D]G}| |td| ||tdHe|dS) aMake a graph of unused and used API entries. The used API entries themselves are documented in the list, so for the graph, we'll focus on the number of unused API entries per modules. Modules with lots of unused entries (11+) will be colored red, those with less (6+) will be colored orange, those with only a few (1-5) will be colored yellow and those with no unused entries will be colored blue. The API entries that are used are shown with one graph per module. That way you can see the examples that each API entry is used in for that module (if this was done for the whole project at once, the graph would get too large very large quickly). Parameters ---------- fname: str Path to '*sg_api_unused.dot' file. entries: Dict[str, List] or List[str] Used (List) or unused (Dict) API entries. gallery_conf : Dict[str, Any] Sphinx-Gallery configuration dictionary. rNscalez0.5)overlappadrfilled20boxzOpen Sans,Arial)ristylefontsizeshapefontname)filename graph_attr node_attrc8g|]}|dS)rrorentrys r:rz_make_graph..es$9995;;s##999r<r rrc4g|]}||kSr8r8)rlevel2structstruct2s r:rz_make_graph..{s6$*!(6&> Ar<z (rzrlrrrrirrhrmoduler)graphvizDigraph API_COLORSrrrrrrrangernodeallrr'roitemssave)rXentriesr>rdg connectionslutstructslevel node_fromnode_to node_kwargs leaf_count color_keyrr"rrefsrefrrs @@r: _make_graphr9s0OOO      ')     B'4  6>ee ff99999W#...% F% FFs6{{Q//$ F$ F5M6%!)#45DDuqy0A BCCC*0-3*>*>Cu &&F5M """ +"ff v;;?e++!"J#* , ,w<<51944$.3EAI.>.>, '!OJ1J1111G-4Cuqy)*!B$+ #a$+ $+ +5i+@K(//;/// 7*V2DEEEEI$ FL##4599(BGG 6 6F\\#&&F3v;;?++ 6 6!a%=++GGF1Iva!e}555 6 6 '4((((("==?? > >KE4 GGENNN > >:g#6777s*V*<==== >GGIIIIIr<c  |pd}|dkrdS|jjddurdStd|d<d}|dxx|d zd t |zzd zz cc<d vsd |dxxdz cc<dSt jdd }tj fddD}t |dkr|dxxdz cc<dSfd}t}t}tt|d} d} |D]} tjd| | | d} | || Lt|| <| D]|} t| d| d| }t'|t jd}|| d|}t-|D]"} |dxxd|| d| dz cc<#|dxxd z cc<t/}|r|r|dxxdz cc<t |}|t |z}|t1|dz }|dxxdt3|dzdd |d!|d"z cc<|r;|r9t5t j|jjd#|dd$ur|rd%}|dxx|d zd t |zzd zz cc<t-|D]Q} |dxxd|| d| d&z cc<|| D]}|dxxd'|dz cc<|dxxd z cc<R|rEd(|D}t-|D]2}|dxx|d d t |zzd)|d*|d+zz cc<3|D]}t:d,|t}|D]t\} }| d-d|krP| dd} d.D]1}| !|r| t |dzd} 2ut5t j|jj|d/|dSdSdSdS)0aWrite an html page describing which API entries are used and unused. To document and graph only those API entries that are used by autodoc, we have to wait for autodoc to finish and hook into the ``source-read`` event. This intercepts the text from the rst such that it can be modified. Since, we only touched an empty file, we have to add 1) a list of all the API entries that are unused and a graph of the number of unused API entries per module and 2) a list of API entries that are used in examples, each with a sub-list of which examples that API entry is used in, and a graph that connects all of the API entries in a module to the examples that they are used in. Parameters ---------- app : The Sphinx application object. docname : Docname of the document currently being parsed. source : List whose single element is the contents of the source file r\ sg_api_usageNrFsphx_glr_sg_api_usagerzUnused API Entriesr^z rrUz%No API entries found, not computed. rc@g|]}|dv d|S)rr8)robj_typer>s r:rz)write_api_entry_usage..s?   <(9::: * +H 5:::r<)classmethodfunctionz No examples run, not computed. c|ddgvrdS|ddgvrdS|ddvsJdS)Nrr r methr func)r')rr>s r:get_entry_typez-write_api_entry_usage..get_entry_typesp L!2377DD D D7 l#4599(BGG G G6L):;JGGGGG6r<zbackreferences_all.jsonrrr}rz- :z:`z` zY.. graphviz:: ./sg_api_unused.dot :alt: API unused entries graph :layout: neato rz API entries used: dz% (rz) sg_api_unused.dotTzUsed API Entriesz` z - :ref:`cDh|]}|ddS)rrrrs r: z(write_api_entry_usage..s)NNNEEKK,,Q/NNNr<z .. graphviz:: ./z_sg_api_used.dot :alt: z! usage graph :layout: neato zMaking API usage graph for %srrSz_sg_api_used.dot)"rrSPHX_GLR_ORPHANrrrrrrunionrrr1rrr9r'r relative_torrrrr.rrrrGr*rrrror)rdocnamesourcetitlerU example_filesrunused_api_entriesused_api_entriesrrr backref_entrybr example_pathref_name has_graphviz used_count total_countused_percentager used_modulesrrrr>s @r:write_api_entry_usager(s.mG.  :1L$%..  &&'>??F1I E 1IIIc%jj 00699III-- , - 5q >> Y.B!CI    ;   M =Qq 99 vv#D);=V$W$WXX9%GGG 8L!34e < < H *..ud;;   % %e , , , ,&*ff U ## G G#BqE2a511==gFF |,,44RVSAA '../E8/E/EFFFF  G *++??q >>>%00>>E>>>>  1IIIIII ??L * q  % %&&Js#5666K 3{A#6#66O 1III , 3& * * , ,  , ,$ , , ,III  *  GLL+-@ A A     $%--2B-"q UT\C#e**$44v== ,--  E 1IIID~~e44DDDDD DIII'. 3 3q 2#2222 1III IIII  NN=MNNNL ..  q MMMC#f++$559-'-9-9-!'9-9-9-- '   ;VDDD&&"2"8"8":":EEJE3{{3''*f44 % k2 > >*6~*FEEJ$// ;;E(-c*oo.A.C.C(DGLL!35P5P5PQQ =.---    r<ctjtj|jjdr>  $ $ Ibgll3;#5t<< = = =>>r<c B|dr|dsdSt|\}}}d}d}d}d} |d} d} |D]} | d| d c} tfd |d |||fDs:|d }| d ttjtjdttj| t|| z } |vr | dz } |dz }n|vs|vrw|vr|d}nd}|dz }| dt| d t|z } | dz } |dz }| | z } | dz } d|||| | z} tj tj ||dtj}t j|dt!jdd5}|| ddddS#1swxYwYdS)ayWrite JUnit XML file of example run times, successes, and failures. Parameters ---------- gallery_conf : Dict[str, Any] Sphinx-Gallery configuration dictionary. target_dir : Union[str, pathlib.Path] Build directory. costs: List[Tuple[Tuple[float], str]] List of dicts of computation costs and paths, see gen_rst.py for details. r~r]Nrgrr\rrc3 K|]}|vV dSr8r8)rrrXs r:rz"write_junit_xml..]s;   QJ      r<rerzBz6rrdz(Passed even though it was marked to failz${!s}rz z zTr1rArBrC)_parse_failuresanyrr rrsplitextrr)r<rr normpathrdirnamer3rHrIrJ)r>rrqfailing_as_expectedfailing_unexpectedlypassing_unexpectedlyn_tests n_failuresn_skipselapsedroutputrrr traceback junit_dirrrXs @r:rrDsH   ^(DFUGGC-/CGJGG9%G F##9d:.5    /0$#$       X&u- P W W"'**27+;+;E+B+BCCAFGG"'//%99::%       ' ' ' N NF qLGG * * *e7K.K.K,,,();>- ( () ]C  &&((((())r<c,fddDS)Nch|]E}tjtjd|FSr)rrr4r)rrr>s r:rz-_expected_failing_examples..sN     l9&=tDDEE   r<rhr8)r>s`r:_expected_failing_examplesrGs4     !<=   r<c td}t}||}||}||}tfd|D}|||fS)zSplit the failures.rdc3RK|]!}tjd||V"dS)rEN)rsearch)rrr>s r:rz"_parse_failures..sO  9\"45x @ @r<)rrG intersection difference)r>rdrhr6r7r8s` r:r1r1s<(:;<< :< H H*778QRR+667PQQ4??@PQQ,  46J JJr<c  |dS|jjdstdddS|jj t \}}}d|rtt t dt|d|D]{}tj | d }tt t |d t d ||g}|r| t td t|d |D]w}tj | d }| dt t|d t d |x|r fd|D}| t tdt|dtdfd|Dzdzdzdzt d} t d | z} t d} td| | | dkrdnd d d| | dkrdndd |rkt tdd|zdzdz} d rt| dSt#| dS)!zCollects the list of falling examples and prints them with a traceback. Raises ValueError if there where failing examples. Nr]zTSphinx-Gallery gallery_conf["plot_gallery"] was False, so no examples were executed.brownrhz zExamples failing as expected (z):rz failed leaving traceback: rdzUnexpected failing examples (z): c\g|](}tj|d)Sr)rrr))rrr>s r:rz.summarize_failing_examples..s;   <=BGOOA|I6 7 7   r<z,Examples expected to fail, but not failing (z): rc38K|]}t|VdSr8r)rridts r:rz-summarize_failing_examples..s+::qF1cNN::::::r<z$ Please remove these examples from z1sphinx_gallery_conf['expected_failing_examples'] zin your conf.py file.rerfz Sphinx-Gallery successfully executed %d out of %d file%s subselected by: gallery_conf["filename_pattern"] = %r gallery_conf["ignore_pattern"] = %r after excluding %d file%s that had previously been run (based on MD5). rrr\rErGzJHere is a summary of the problems encountered when running the examples: zO-------------------------------------------------------------------------------ra)rrrrr1rrrrrr)r rrrrrr)rr,r6r7r8 fail_exampler fail_msgspathsn_goodn_totn_stale fail_messager>rQs @@r:summarize_failing_examplesrYs  : ). 9  3    :1LFUGGC-/C C  Ss;N7O7OSSSTT U U   0  L7??<i1HIID KKT ##QQ,'9:<H#NNQQ     I  TS9M5N5NTTTUU V V   1  L7??<i1HIID   QtCIIQQ,'9:<H#NNQQ           AU     VCJJVVVWW X X$))::::E:::::;; <6 7B B&  &   01 2 2F  /0 1 1F :E,/011G KK   zzr'(%&!||" / 1))I&&'      4 5 / NN< ( ( ( ( ( .. . / /r<cfd}|S)z#Get default configuration function.cR|dtS)Nr)r'r)confrs r:default_getterz0get_default_config_value..default_getters%)*..s4H4MNNNr<r8)rr]s` r:get_default_config_valuer^s)OOOOO r<ct|j||}||_|jt |jt ttj dz dS)aCheck the sphinx-gallery config and set its defaults. This is called early at config-inited, so that all the rest of the code can do things like ``sphinx_gallery_conf['binder']['use_jupyter_lab']``, even if the keys have not been set explicitly in conf.py. )rr componentsN) rrhtml_static_pathrrtemplates_pathrr__file__parent)rrrnew_sphinx_gallery_confs r:fill_gallery_conf_defaultsrf"s:" "9F ""?#4#4555    T(^^%:\%I!J!JKKKKKr<ct|jjj}|jj}t|jjj}t |jj||||jjdS)z7Update the the sphinx-gallery config at builder-inited.)r]r`rN) rrGrr]r*r`rrrt)rr]rr`s r:"update_gallery_conf_builder_initedrh5sqck0=>>Lk G' (:(QRR' &!5[% r<c<fdfd}fd}||d<||d<dS)zSet up the getters for download and launcher links. The getters are added to the sphinx context so as to be used in templates. cXtgSfdS)Ncrt|tjo|jdgvS)Nclasses)rr container attributesr')r class_names r:zRsetup_template_link_getters.._find_containers_with_class..Ns5jEO44>al..y"===r<)iterfindall)rodoctrees`r:_find_containers_with_classz@setup_template_link_getters.._find_containers_with_classIs> ?88O > > > >   r<ci}dD]x\}}d|}t|dx}rS|jdjdj}|dx}rd|||dd||<y|S) a[Get the download links for the example. This function relies on `_find_containers_with_class` which in turn relies on `doctree` provided in the `html-page-context` event. This function will then be added to the context of the page and can be accessed in the template. This returns a dictionary with keys in ["python", "jupyter", "zip"], depending on their availability. The values contain: - link: The relative path to the download file - label: The "Download {label}" text - title: The title to show when hovering over the link ))pythonz source code)jupyterzJupyter notebook)r4zippedzsphx-glr-download-Nrrz _downloads/ reftarget)linklabelrnextchildrenrnr')linksrr{ containersrmattrsrzrts r:get_download_linksz7setup_template_link_getters..get_download_linksRs  JC 545O#5O5OPPJ T222y !*1-6q9D 99Z0004 4d 4 4!&!&;!7!7""E#J  r<c4i}dD]}|d}t|dx}ro|jd}|jd}|jdx}r9||jd|jdd||<|S) aZGet the launcher links for the example. This function relies on `_find_containers_with_class` which in turn relies on `doctree` provided in the `html-page-context` event. This function will then be added to the context of the page and can be accessed in the template. This returns a dictionary with keys in ["lite", "binder"], depending on their availability. The values contain: - link: The URL to Binder or JupyterLite link of the example - img_alt: The alt text for the link badge - img_src: The source URL of the link badge )litermz-badgeNrrefurialturi)rzimg_altimg_srcr|)rrrrmanchorimagerzrts r:get_launcher_linksz7setup_template_link_getters..get_launcher_linksps%  C44^^^DDJ T222y "+A.*!,00:::4 $#(#3#7#7#>#>#(#3#7#7#>#>""E#J  r<rrNr8)rpagename templatenamecontextrsrrrts ` @r:setup_template_link_gettersrCsm      <6%7G !$6G !!!r<cF|dtddD]&}||t|d'|dtd|dt d|dt dd |jvrQ|d t|d t|d t| d t| d tt||dtd|dt |dt"|dt$|dt&|dt(|dt*|dt,ddt.d}|S)z&Setup Sphinx-Gallery sphinx extension.rr)r]r`z config-initedrl)priorityrizsphinx.ext.autodoczautodoc-process-docstringz source-read minigalleryzimage-sgzbuilder-initedzbuild-finishedzhtml-page-contextT)parallel_read_safeparallel_write_safer)add_config_valuerr^connectrfr&r% extensionsrDrr( add_directiverrrrhrr#r$rYrr.r _sg_version)rrmetadatas r:setuprs.0DfMMM9II S":3"?"?HHHHKK!;bKIIIKK!ACKPPPKK!BSKQQQs~-- /1KLLL /1BCCC M#8999m[111j'***CKK "DrKRRRKK "6777KK "3444KK "=>>>KK "<===KK "2333KK "7888KK#%@AAA##H Or<cdS)z-Hack to stop nosetests running setup() above.Nr8r8r<r: setup_modulersDr<)TFr)FF)NT)T)rDrHrrr rrrdifflibr itertoolsrrtextwrapr xml.sax.saxutilsr r sphinx.utilsphinxdocutilsr sphinx.errorsr rsphinx.util.consolerrrrr\rrrbackreferencesr directivesrrr docs_resolvr downloadsrgen_rstrrrrr interactive_exampler!r"r#r$r%r&rbr'r(scrapersr)sortingr*utilsr+r,r-r.r/r0r1r2r3r r6rrrrgetenvrutillogging getLoggerrrrrrrrrrrrr/r5r>rSrerxrrrrrrmrkrrrrrr(r.rrDrGr1rYr^rfrhrrrr8r<r:rsz    ((((((((%%%%%%........55555555777777777777((((((444444==========))))))((((((DCCCCCCC((((((""""""                       @  "&))F2@o@RW\\$ 33@5' @  @ E7 @""$$@@9@d@O@$@"@CCEE@R@ /!@"#@@.F/@0T1@2e3@4!%5@6He$7@89@:;@<b=@>%?@@ A@BjC@DE@Fyry)<==EG@H bI@J2K@LUM@NoO@@@PrQ@R.S@T8U@V4W@X$Y@Zu[@\]@^e_@`5a@bdc@d Re@f)95g@hi@j :k@lUm@nBo@p$q@@r#%%"@@@D   & &'7 8 8 ? ? ?&  7 7 7 7'''* @???"@@@D ; ; ;FDVVVVr9999x2220 $ $ $$.$.$.N!E!E!EH"""$dAdAdAN    888 16*****ZNNNbFFF@   T       ```FWWWt > > >HHHV)))( K K K \/\/\/~LLLL&   I7I7I7X+++\     r<