+ g\^RIHt^RIt^RIt^RIt^RIt^RIt^RIt^RIt^RI H t ^RI H t H t ^RIHtHtHtHtHtHtHt^RIHt^RIt^RIt^RIt^RIHt]'d^RIt^RI H!t!^R I"H#t#]PH!]%4t&!R R ]PN4t(!R R 4t)!RR4t*]PVPXP[RR.4t.RRlt/RRlt0RRlt1RRlt2RRlt3RRlt4R#)) annotationsN)cached_property)PurePath PurePosixPath) TYPE_CHECKINGCallableIterableIteratorMappingSequenceoverload)quote)utils) MkDocsConfig)PagecX]tRt^tR tR tR t^t^tRt Rt Rt Rt Rt RtRtR#) InclusionLevelc R#)Tselfs&8/usr/lib/python3/dist-packages/mkdocs/structure/files.pyallInclusionLevel.all+sc HVPVPP8#NvalueDRAFTrs&r is_includedInclusionLevel.is_included.szzDJJ,,,,rc HVPVPP8*#rrrs&r is_excludedInclusionLevel.is_excluded1zzTZZ----rc HVPVPP8#rrrs&r is_in_serveInclusionLevel.is_in_serve4r&rc HVPVPP8#rr NOT_IN_NAVrs&r is_in_navInclusionLevel.is_in_nav7szzDOO1111rc HVPVPP8*#rr+rs&r is_not_in_navInclusionLevel.is_not_in_nav:szzT__2222rrN)__name__ __module__ __qualname____firstlineno__EXCLUDEDr r, UNDEFINEDINCLUDEDrr!r$r(r-r0__static_attributes__rrrrrsHH9 EfJIIuHp-..23rrcj]tRt^>tRtRRltRRltRRltRR lt] R R l4t ] R R l4t RRlt RRlt RRltR)R]P /RRllltR]P /RRlltRRltRRltRRltRR ltR!R"lt] R#R$l4t]P2R%R&l4tR'tR(#)*Filesz>""rc V^8dQhRRRR/#)r@pathstrrCboolr)rEs"rrFrGLs;;;;rc N\V4P4VP9#)z?Soft-deprecated, prefer `get_file_from_path(path) is not None`.)ras_posixrJrr[s&&r __contains__Files.__contains__Ls~&&(DNN::rcV^8dQhRR/#)r@rCzdict[str, File]r)rEs"rrFrGQs66?6rc DVUu/uFqPVbK up#uupi)z#Soft-deprecated, prefer `src_uris`.)src_pathrfiles& r src_pathsFiles.src_pathsPs#155 t#555scV^8dQhRR/#)r@rCzMapping[str, File]r)rEs"rrFrGVs,rc VP#)zn A mapping containing every file, with the keys being their [`src_uri`][mkdocs.structure.files.File.src_uri]. rJrs&rsrc_urisFiles.src_urisUs ~~rc V^8dQhRRRR/#)r@r[r\rCz File | Noner)rEs"rrFrG]s==s={=rc fVPP\V4P44#)z7Return a File instance with File.src_uri equal to path.)rJgetrr_r`s&&rget_file_from_pathFiles.get_file_from_path]s$~~!!(4."9"9";<> ) MMMOa t||,'+t||$rc V^8dQhRRRR/#rur)rEs"rrFrGjsDD4DDDrc VPVPR# \d\TP: R24hi;i)z"Remove file from Files collection.z not in collectionN)rJrIKeyError ValueErrorrfs&&rremove Files.removejsA Dt||, D //ABC C Ds %A inclusionc$V^8dQhRRRRRR/#)r@dirtyr]r Callable[[InclusionLevel], bool]rCrDr)rEs"rrFrGqs( & & &4 &  &rc VFFpVP4'dKV!VP4'gK5VPV4KH R#)z-Copy static files from source to destination.N)is_documentation_pager copy_file)rrrrgs&&$ rcopy_static_filesFiles.copy_static_filesqs7D--//Idnn4M4Mu%rc V^8dQhRRRR/#)r@rrrCSequence[File]r)rEs"rrFrG|s ee<e erc VUu.uF6q"P4'gKV!VP4'gK4VNK8 up#uupi)z2Return iterable of all Markdown page file objects.)rr)rrrgs&$ rdocumentation_pagesFiles.documentation_pages|s7"&d)C)C)E)TXTbTbJcdddsAAAcV^8dQhRR/#r@rCrr)rEs"rrFrGs@@n@rc ^VUu.uFqP4'gKVNK up#uupi)z0Return iterable of all static page file objects.)is_static_pagerfs& r static_pagesFiles.static_pagess%!%?)<)<)>???**cV^8dQhRR/#rr)rEs"rrFrGs??^?rc ^VUu.uFqP4'gKVNK up#uupi)zPReturn iterable of all file objects which are not documentation or static pages.) is_media_filerfs& r media_filesFiles.media_files%!%>););)=>>>rcV^8dQhRR/#rr)rEs"rrFrGs??.?rc ^VUu.uFqP4'gKVNK up#uupi)z/Return iterable of all javascript file objects.) is_javascriptrfs& rjavascript_filesFiles.javascript_filesrrcV^8dQhRR/#rr)rEs"rrFrGs88>8rc ^VUu.uFqP4'gKVNK up#uupi)z(Return iterable of all CSS file objects.)is_cssrfs& r css_filesFiles.css_filess"!%7777rc$V^8dQhRRRRRR/#)r@envzjinja2.EnvironmentconfigrrCrDr)rEs"rrFrGs#(:LUYrc  aV3RlpVPVR7FpVPV4eKSPPFxp\P P \P PWT44'gKGVP\WESPSP44K K R#)zCRetrieve static files from Jinja environment and add to collection.c6<.ROpVPR4VPR\P44VPSPP 4VF1p\ P !VP4V4'gK0R# R#).*z locales/*c3,"TF pRV 2xK R#5i)*Nr).0xs& r =Files.add_files_from_theme..filter..sG-FasG-FsFT)rz*/.*z*.pyz*.pycz*.htmlz*readme*zmkdocs_theme.yml)r{extendrmarkdown_extensionsthemestatic_templatesfnmatchlower)namepatternspatternrs& rfilter*Files.add_files_from_theme..filtersk`H OOK ( OOGU-F-FG G OOFLL99 :#??4::<99 $r) filter_funcN) list_templatesrrrdirsosr[isfilejoinr{rvsite_diruse_directory_urls)rrrrr[dirs&&f radd_files_from_themeFiles.add_files_from_themes &&6&:D&&t,4!<<,,Cww~~bggll3&=>> DFOOVE^E^$_` -;rcV^8dQhRR/#)r@rCrBr)rEs"rrFrGsrc <\P!R\4V#)Do not access Files._files.)rxryrzrs&r_files Files._filess 35GH rcV^8dQhRR/#)r@rrBr)rEs"rrFrGs77N7rc \P!R\4VUu/uFq"PVbK upVnR#uupi)rN)rxryrzrIrJ)rrrKs&& rrrs1 35GH0561))Q,66s?rlNF)r5r6r7r8__doc__rLrRrXrapropertyrhrmrrr{rrr!rrrrrrrrsetterr<rrrr>r>>sF7-#;66=,D &7E6P6P & &e?M?Y?Ye @??80 ]]77rr>c]tRt^t$RtR]R&R]R&R]R&R]R&]PtR ]R &R t R]R &R t R ]R&] RRl4t ] PRRl4t ] RRl4t]PRRl4tR tR]R&]]R ]P/RRll44t]]R ]P/RRll44t]RR RR R ]P/RR ll4tR!R R ]P/R"R#lltR$t]P,R%R&l4tR'R(lt]!]4tRJR)R*llt]!]4tRJR+R,llt]!]4t]R-R.l4t]R/R0l4t R1R2lt!] R3R4l4t"]"PR5R6l4t"] R7R8l4t#]#PR9R:l4t#RKR;R<llt$R=R>lt%R?R@lt&RARBlt'RCRDlt(RERFlt)RGRHlt*RIt+R #)Lrva A MkDocs File object. It represents how the contents of one file should be populated in the destination site. A file always has its `abs_dest_path` (obtained by joining `dest_dir` and `dest_path`), where the `dest_dir` is understood to be the *site* directory. `content_bytes`/`content_string` (new in MkDocs 1.6) can always be used to obtain the file's content. But it may be backed by one of the two sources: * A physical source file at `abs_src_path` (by default obtained by joining `src_dir` and `src_uri`). `src_dir` is understood to be the *docs* directory. Then `content_bytes`/`content_string` will read the file at `abs_src_path`. `src_dir` *should* be populated for real files and should be `None` for generated files. * Since MkDocs 1.6 a file may alternatively be stored in memory - `content_string`/`content_bytes`. Then `src_dir` and `abs_src_path` will remain `None`. `content_bytes`/`content_string` need to be written to, or populated through the `content` argument in the constructor. But `src_uri` is still populated for such files as well! The virtual file pretends as if it originated from that path in the `docs` directory, and other values are derived. For static files the file is just copied to the destination, and `dest_uri` equals `src_uri`. For Markdown files (determined by the file extension in `src_uri`) the destination content will be the rendered content, and `dest_uri` will have the `.html` extension and some additional transformations to the path, based on `use_directory_urls`. r\rIr]r str | Nonesrc_dirdest_dirrrN generated_bystr | bytes | None_contentcV^8dQhRR/#r@rCr\r)rEs"rrFFile.__annotate__s..#.rc T\PPVP4#)z^Same as `src_uri` (and synchronized with it) but will use backslashes on Windows. Discouraged.)rr[normpathrIrs&rre File.src_pathsww --rcV^8dQhRR/#r@rr\r)rEs"rrFrs22c2rc B\V4P4VnR#r)rr_rIrrs&&rrers//1 rcV^8dQhRR/#rr)rEs"rrFrs//3/rc T\PPVP4#)z_Same as `dest_uri` (and synchronized with it) but will use backslashes on Windows. Discouraged.)rr[rdest_urirs&r dest_pathFile.dest_pathsww ..rcV^8dQhRR/#rr)rEs"rrFrs33s3rc B\V4P4VnR#r)rr_rrs&&rrrs 002 rz Page | Nonepagec ,V^8dQhRRRRRRRRR R /#) r@rrrIr\contentz str | bytesrrrCrvr)rEs"rrFrs<         "     rc R#)zp Create a virtual file backed by in-memory content. It will pretend to be a file in the docs dir at `src_uri`. Nr)clsrrIrrs&&&$$r generatedFile.generated rc ,V^8dQhRRRRRRRRRR /#) r@rrrIr\ abs_src_pathrrrCrvr)rEs"rrFrs<         "     rc R#)z Create a virtual file backed by a physical temporary file at `abs_src_path`. It will pretend to be a file in the docs dir at `src_uri`. Nr)rrrIrrs&&&$$rrrrrrrc 0V^8dQhRRRRRRRRR R R R /#) r@rrrIr\rrrrrrrCrvr)rEs"rrFr.sF $  ! " rc VRJVRJ8Xd \R4hV!VRVPVPVR7pVPP;'gRVnWFnW6nV#)z Create a virtual file, backed either by in-memory `content` or by a file at `abs_src_path`. It will pretend to be a file in the docs dir at `src_uri`. Nz9File must have exactly one of 'content' or 'abs_src_path')rrrrz ) TypeErrorrrplugins_current_pluginrrr)rrrIrrrrKs&&&$$$ rrr-sn tO!5 6WX X  __%88   77FF;% rrc4V^8dQhRRRRRRRRRRR R R R /#) r@r[r\rrrrr]rrrrCrDr)rEs"rrFrJsP#### # ! ##"# #rc VWnW nW0nW@nVeWPnW`nR#r)rerrrrr)rr[rrrrrs&&&&&$$rrL File.__init__Js)   "4  $M"rc \V4P RVP: RVP: RVP: RVP : RVP : RVP R2#)(z , src_dir=z , dest_dir=z, use_directory_urls=z , dest_uri=z , inclusion=))typer5rIrrrrrrs&r__repr__ File.__repr__\snDz""#1T\\$4Jt||>NO ((=d>U>U=XY ( T^^4DA G rcV^8dQhRR/#r@rCrr)rEs"rrFrdsCC*Crc :VPf VP#R#)z A path relative to the source repository to use for the "edit" button. Defaults to `src_uri` and can be overwritten. For generated files this should be set to `None`. N)rrIrs&redit_uri File.edit_urics $008t||BdBrcV^8dQhRR/#rr)rEs"rrFrms5535rc \P!VP4p\P!V4wr#VR8XdR#T#)Soft-deprecated, do not use.READMEindex) posixpathbasenamerIsplitext)rfilenamestemexts& r _get_stemFile._get_stemms:%%dll3&&x0 (*w44rc V^8dQhRRRR/#r@rz bool | NonerCr\r)rEs"rrFrvs    rc lVP4'd\P!VP4wr#Vf VPpV'dVP R8Xd(\P !W P R,4#\P !W P R4#VP#)r r.html index.html)rrsplitrIrrr)rrparentrs&& r_get_dest_pathFile._get_dest_pathvs  % % ' '(t||< F!)%)%<%<"%g)=!~~fii'.ABB!~~fiiFF||rc V^8dQhRRRR/#rr)rEs"rrFrs;#rc VPp\P!V4wr4Vf VPpV'dVR8XdT;'gRR,p\ V4#)r r./)rrrrurlquote)rrurldirnamers&& r_get_url File._get_urlsRmm%OOC0  %!%!8!8  (l":>>cS(C}rcV^8dQhRR/#rr)rEs"rrFrsJJjJrc VPfR#\PP\PP VPVP 44#)z The absolute concrete path of the source file. Will use backslashes on Windows. Note: do not use this path to read the file, prefer `content_bytes`/`content_string`. N)rrr[rrrIrs&rrFile.abs_src_paths= << ww T\\4<< HIIrcV^8dQhRR/#rr)rEs"rrFrsLLsLrc \PP\PPVPVP 44#)zTThe absolute concrete path of the destination file. Will use backslashes on Windows.)rr[rrrrrs&r abs_dest_pathFile.abs_dest_paths0ww T]]DMM JKKrc V^8dQhRRRR/#)r@otherz File | strrCr\r)rEs"rrFrsaaZaCarc \P!VP\V\4'dVP4#T4#)z+Return url for file relative to other file.)rget_relative_urlr& isinstancerv)rr2s&&rurl_relative_toFile.url_relative_tos2%%dhhZt=T=T ``Z_``rcV^8dQhRR/#)r@rCbytesr)rEs"rrFrsurc *VPpVfJVPfQh\VPR4;_uu_4pVP4uuRRR4#\ V\ 4'gVP 4pV# +'giL8;i)z Get the content of this file as a bytestring. May raise if backed by a real file (`abs_src_path`) if it cannot be read. If used as a setter, it defines the content of the file, and `abs_src_path` becomes unset. Nrb)rropenreadr5r9encoderrrKs& r content_bytesFile.content_bytessq-- ?$$0 00d''..!vvx/.'5))nn&G /.s B B cV^8dQhRR/#)r@rr9r)rEs"rrFrs!!5!rc P\V\4'gQhWnRVnR#r)r5r9rrrs&&rr@rAs"%''''  rcV^8dQhRR/#rr)rEs"rrFrsrc 4VPpVfLVPfQh\VPRRR7;_uu_4pVP4uuRRR4#\ V\ 4'gVP RRR7pV# +'giL;;i)z Get the content of this file as a string. Assumes UTF-8 encoding, may raise. May also raise if backed by a real file (`abs_src_path`) if it cannot be read. If used as a setter, it defines the content of the file, and `abs_src_path` becomes unset. Nz utf-8-sigstrict)encodingerrors)rH)rrr<r=r5r\decoder?s& rcontent_stringFile.content_strings|-- ?$$0 00d''+hOOSTvvxPO'3''nn[nBG POs B B cV^8dQhRR/#rr)rEs"rrFrs!!C!rc P\V\4'gQhWnRVnR#r)r5r\rrrs&&rrJrKs"%%%%%  rc V^8dQhRRRR/#)r@rr]rCrDr)rEs"rrFrs++t++rc PV'd<VP4'g&\PRVP R24R#\PRVP R24VPp\ P !\ PPV4RR7VPpVf5VPfQh\P!VPV4R#\V\ 4'd3\#VRRR 7;_uu_4pVP%V4RRR4R#\#VR 4;_uu_4pVP%V4RRR4R# \PdR#i;i +'giR#;i +'giR#;i) zCCopy source file to destination, ensuring parent directories exist.zSkip copying unmodified file: ''NzCopying media file: 'T)exist_okwzutf-8)rGwb) is_modifiedlogdebugrIr/rmakedirsr[r'rrrrshutil SameFileErrorr5r\r<write)rr output_pathr output_files&& rrFile.copy_files8 ))++ II7 ~QG H  )$,,q9:((  BGGOOK04@-- ?$$0 00  1 1;? % %k399[!!'*:9k4((K!!'*)( ''  :99)((s* !E$FF$E=<E= F  F% cV^8dQhRR/#r@rCr]r)rEs"rrFrsTrc JVPeR#VPfQh\PP VP 4'dT\PP VP 4\PP VP48#R#)NT)rrrr[rr/getmtimers&rrTFile.is_modifiedsr == $  ,,, 77>>$,, - -77##D$6$67"'':J:J4K\K\:]] ]rcV^8dQhRR/#r_r)rEs"rrFrs44t4rc B\P!VP4#)z'Return True if file is a Markdown page.)ris_markdown_filerIrs&rrFile.is_documentation_pages%%dll33rcV^8dQhRR/#r_r)rEs"rrFrsIIIrc 8VPPR4#)z7Return True if file is a static page (HTML, XML, JSON).)rz.htmz.xmlz.jsonrIendswithrs&rrFile.is_static_pages||$$%GHHrcV^8dQhRR/#r_r)rEs"rrFrsKKtKrc \VP4;'gVP4'*#)z:Return True if file is not a documentation or static page.)rrrs&rrFile.is_media_files%..0IID4G4G4IJJrcV^8dQhRR/#r_r)rEs"rrFrsEEtErc 8VPPR4#)z)Return True if file is a JavaScript file.)z.jsz .javascriptz.mjsrirs&rrFile.is_javascripts||$$%CDDrcV^8dQhRR/#r_r)rEs"rrFrs---rc 8VPPR4#)z"Return True if file is a CSS file.z.cssrirs&rr File.is_csss||$$V,,r) rrrrrrrerIrrr),r5r6r7r8r__annotations__rr:rrrrrerrrr classmethodrrLrr weak_propertyr rrrrrr(r&rr/r6r@rJrrTrrrrrr<rrrrvrvsBLcHMj . 8 8I~8@#L*#t$(H '! ..__22//33D+   %3$<$<      %3$<$<     '+  $( %3$<$<8# $#%3$<$<#$  CC5 9 %D< ~.Hm ( #C\JJLLa"!! "!! +,4IKE--rrvrz /templates/c$V^8dQhRRRRRR/#)r@rArBrrrCrDr)rEs"rrFrFs!99.9,949rcVPR4pV'd\V,M\pVPR4pVPR4pVFpVP\P8XgK$VP VP 4'd\PVnK\V'd9VP VP 4'd\PVnKV'd9VP VP 4'd\PVnK\PVnK R#)zKRe-calculate which files are excluded, based on the patterns in the config. exclude_docs draft_docs not_in_navN) rq_default_excluderrr: match_filerIr9r r,r;)rArexcludedrafts nav_excludergs&& rset_exclusionsrs7=zz.7QG,3(9IG6>^55 5!!$,,//!/!8!8F--dll;;!/!5!5!7!7 !E!E!/!:!:!/!8!8rc V^8dQhRRRR/#)r@rrrCr>r)rEs"rrFrF"s**l*u*rc .p.p\P!VR,RR7Fwr4p\PPW0R,4pVP 4VP \ R7/pVFp\ \PPWh4VR,VR,VR,4p VPV PV 4p WJdVPW34VPV 4T p K K \W4VFwrV PP4'deV PP4'd1\PRV P RV P R 24VP#V 4KVP#V 4K \'V4# \$dKi;i \$dKi;i) z2Walk the `docs_dir` and return a Files collection.docs_dirT) followlinkskeyrrz Excluding 'z+' from the site because it conflicts with 'z'.)rwalkr[relpathsort_file_sort_keyrvr setdefaultrr{rrr!rUwarningrIrrr>) rrAconflicting_files source_dirdirnames filenames relative_dir files_by_destrrg prev_fileabs & r get_filesr"sE13+-776*3ESW+X' iwwz*3EF  >*)+ !H \4z"z"+, D&00EI$!(()):; LL I" ,Y(5!! ;; " " $ ${{&&(( !!)),WXYXaXaWbbde  Q  Q" <     s$G"G GG G#"G#cV^8dQhRR/#)r@rKrvr)rEs"rrFrFOs 6 6T 6rc\VP4PpV'gR#VRRVPR8gVR,3#)z Replicates the sort order how `get_files` produces it - index first, directories last. To sort a list of `File`, pass as the `key` argument to `sort`. Nrrr4)rrIpartsr)rKrs" r file_sort_keyrOs@ !)) $ * *E  #2J')59 55rcV^8dQhRR/#)r@rKr\r)rEs"rrFrF[sBBcBrcX\PPV4^,R9V3#)zaAlways sort `index` or `README` as first filename in list. This works only on basenames of files.)rr)rr[r)rKs&rrr[s' GG  Q  "*= =q AArc V^8dQhRRRR/#)r@r Iterable[str]rCz list[str]r)rEs"rrFrF`s11=1Y1rc$\V\R7#)r r)sortedr)rs&r _sort_filesr`s ) 00rc ,V^8dQhRRRRRRRRRR/#) r@rr\r[is_dirr]rrrCr)rEs"rrFrFes0  C s D = UY rc"\P!R\4VFmpVPR4'd V'gK$VP R4'dTMTp\ P !WTP R44'gKlR# R#)zD_filter_paths is not used since MkDocs 1.5 and will be removed soon.r$TF)rxryrzrj startswithrstrip)rr[rritemmatchs&&&& r _filter_pathsresj MMNPb ==  f ,,( ??5**S/ 2 2 r)5 __future__renumrloggingrrrXrx functoolsrpathlibrrtypingrrr r r r r urllib.parserr%pathspecpathspec.gitignore pathspec.utilmkdocsrjinja2.environmentjinja2mkdocs.config.defaultsrmkdocs.structure.pagesr getLoggerr5rUEnumrr>rv gitignore GitIgnoreSpec from_linesr}rrrrrrrrrrs"   %+[[[*3+!3TYY3>t7t7nT-T-n %%33>>m?TU9&*Z 6B 1 r