}ctKdZddlZddlZddlZddlZddlZddlmZddlmZddlm Z ddlm Z ddl m Z m Z mZmZddlZddlmZmZdd lmZdd lmZdd lmZmZdd lmZd ejvr!ejd dZngdZdee zZ e j!eddZ"de#de$fdZ%de#de#fdZ&d9de#dee#de$fdZ'de#de#de ddfdZ( d:de#d e#de d!e#ddf d"Z)gdfd#e#d$e#d%e#d&ee#de d'ee#d(e$d)ee#d!e#ddfd*Z* d;d+ee#de de#d!e#ddf d,Z+gfde#de d)ee#de$fd-Z,de#de d)ee#de$fd.Z-d/e#d)ee#de de ee#ee#ee#fddffd0Z.d/e#d)ee#de de$fd1Z/ d:d/e#d)ee#de d!e#dee#f d2Z0d#e#d)ee#de$fd3Z1dej2fd4Z3ej4d5dfd6ee#de5fd7Z6e7d8kr e6dSdS)). This is derived from the "sphinx-autopackage" script, which is: Copyright 2008 Société des arts technologiques (SAT), https://sat.qc.ca/ N)copyfnmatch)EXTENSION_SUFFIXES)path)Any GeneratorListTuple)__display_version__ package_dir) EXTENSIONS)__)FileAvoidWrite ensuredir) ReSTRendererSPHINX_APIDOC_OPTIONS,)membersz undoc-memberszshow-inheritance)z.pyz.pyx templatesapidocfilenamereturnctj|}tttdD]}|d|zkrdSdS)z)Check *filename* is __init__ file or not.T)keyreverse__init__F)rbasenamesorted PY_SUFFIXESlen)rrsuffixs 1lib/python3.11/site-packages/sphinx/ext/apidoc.py is_initpyr$.sT}X&&H#t<<< zF* * 44 umodnamescHdtd|S)zJoin module names with dots..N)joinfilter)r&s r# module_joinr+8s 88F4** + ++r%dirnamefilescl||dS|tj|}td|DS)z+Check given *files* contains __init__ file.NFc38K|]}t||VdSNr$.0fs r# z is_packagedir..Ds-00Q9Q<<0q000000r%)oslistdirany)r,r-s r# is_packagedirr9=sJ u $ 7## 00%000 0 00r%nametextoptsct|dd}tj|j|d|j}|jr#|st td|zdS|js9tj |r%|s!t td|zdSdS|st td|zt|5}| |ddddS#1swxYwYdS)z0Write the output file for module/package .quietNr(zWould create file %s.z!File %s already exists, skipping.zCreating file %s.) getattrrr)destdirr"dryrunprintrforceisfilerwrite)r:r;r<r>fnamer4s r# write_filerGGs\ D'4 ( (E IdltttT[[$A B BE { 7 ",--5 6 6 6 :$+e,, C "899EA B B B B B C C 3 "())E1 2 2 2 E " " a GGDMMM                  sC33C7:C7packageruser_template_dirctt}|jrd|vr|dt ||}|j |||d}t |tgd|}t|||dS).Build the text of the file and write the file.private-members) show_headingsrqualnameautomodule_optionsz module.rst_tN) rOPTIONSincludeprivateappendr+ noheadingsr template_dirrenderrG)rHrr<rIoptionsrNcontextr;s r#create_module_filerXZs7mmG *0?*()))7H--H!_,% G *L9 : : A A.RY Z ZDxt$$$$$r%rootmaster_packagesubrootpy_filessubs is_namespaceexcludesc 2fd|D} fd|D} tt| } fd| D} tt} jrd| vr| dt } | | | |jj| j j d } t|tg d| }t| || rjr| D]}td||dSdSdS)rKczg|]7}ttj|&t|8S)is_skipped_packagerr)r+)r3pkgnamer_rZr<rYr[s r# z'create_package_file..qsYXXX,TYtW-E-EtXVVX;~w@@XXXr%cg|]P}ttj|&t|5|ddQS)r(r)is_skipped_modulerr)r$split)r3subr_r<rYs r#rez'create_package_file..usb&&&*49T3+?+?xPP&nn&#))C..#&&&r%c2g|]}t|Srb)r+)r3modnamerZr[s r#rez'create_package_file..ys5---ngw??---r%rL) rd subpackages submodulesr^ modulefirstseparatemodulesrOrMmaxdepthz package.rst_tN)rsetrrPrQrRr+rnrorSrprrTrUrGrX)rYrZr[r\r<r]r^r_rIrlrmrVrdrWr; submodules``` ` ` r#create_package_filersls XXXXXXXX"&XXXK&&&&&&x&&&JJ((J-----!+---J7mmG *0?*())).'22G" $'/%!_,M  G *L9 : : A A/SZ [ [Dwd###Id*I# I II tY6G H H H HIIII I Ir%modulescB|d}|ddD]2}||dzr||0|}3|j|j|d}t |t gd|}t|||dS)zCreate the module's index.Nr()headerrpdocnamesz toc.rst_t) sort startswithremoverwrprrTrUrG)rtr<r:rI prev_modulemodulerWr;s r#create_modules_toc_filer~s LLNNNK!!!*!!   [3. / / ! NN6 " " " " KK+MG *L9 : : A A+w W WDtT4     r%ctjsdStjtjd}t d|D}|s |jsdSt fd|DrdSdS)%Check if we want to skip this module.Fz*.pyc38K|]}t||VdSr0r1r2s r#r5z%is_skipped_package..s-;;ill;!;;;;;;r%Tc3^K|]'}ttj|V(dSr0) is_excludedrr))r3r4r,r_s r#r5z%is_skipped_package..s9 G GA;ty!,,h 7 7 G G G G G Gr%)risdirglobr)r8implicit_namespacesall)r,r<r_r-regular_packages` ` r#rcrcs :g  u Idi00 1 1E;;U;;;;;O 4#;t G G G G G G G GGGtur%ctj|sdStj|dr |jsdSdS)rT_F)rexistsrrzrQ)rr<r_s r#rgrgsM ;x t x + +C 0 09Ltur%rootpathc#&Kt|dd}t|dd}tj||D]R\}}tfd|D}|rdndtfd|D|d d <||fVSd S) z@Walk through the directory and list files and subdirectories up. followlinksFrQ)rc3K|]C}|tttj|?|VDdSr0)endswithr rrr))r3r4r_rYs r#r5zwalk..soFFQ**[11F&tyq'9'98DDFqFFFFFFr%)r()r(rc3K|]>}|ttj|:|V?dSr0)rzrrr))r3riexclude_prefixesr_rYs r#r5zwalk..soJJCNNCS4T4TJ(4)=)=xHHJJJJJJJr%N)r?r6walkr) rr_r<rrQr]r-rrYs ` @@r#rrs"$ u55KT#3U;;NWX;GGG  dEFFFFF%FFFFF  *06  ) JJJJJJJJJJJQQQD%!  r%c@t|||D] \}}}|rdS dS)zACheck the given directory contains child module/s (at least one).TF)r)rr_r<_root_subsr-s r#has_child_modulers?#Hh==ue  44  5r%c *t|dd}t|s|r&|tjd}nd}g}t |||D]\}}} td| } | o|} | rH| ddD]<} t | r+| | | d| =n||kr|s|dd=t| s| r|s#t| dkst||s|t|d tj tjd} | rt|||r:t||| | ||| || |t!|| >||kr|J| D]h}t#tj||||sB|dd}t'||||||i|S)z` Look for every file in the directory tree and create the corresponding ReST files. rFNrr()r?r9rhrseprr$r{insertr!rclstripreplacerrsrRr+rgr)rX)rr_r<rIr root_package toplevelsrYr]r-is_pkgr^r4 subpackagepy_filer}s r# recurse_treers "$(=uEEX"5~~dh//3  I!(Hd;;!-!-dEtU++!z9&9  111X ' 'Q<<'LLOOOLLA&&& 'X  & G  -\ - Ls5zzA~ L-?d-K-K L!#h--..188BBGDHc**$L'7h'M'ML'lJ(-tT<(9;;;$$[z%J%JKKK8# < < < <  - -(8W)E)EtXVV-$]]3//2F&|VTCTUUU$$V,,,  - r%c6|D]}t||rdSdS)zCheck if the directory is in the exclude list. Note: by having trailing slashes, we avoid common prefix issues, like e.g. an exclude "foo" also accidentally excluding "foobar". TFr)rYr_excludes r#rrs6  4 ! ! 44  5r%c tjdtdtd}|ddddtz |d td  |d dtd|dddddtd|dddtd|ddddt d td!"|d#d$dd%td&|d'd(dd)d*td+,|d-d.dd/td0|d1d2dd3td4|d5d6dd7td8|d9dd:d;td<,|d=d>d?d:td@|dAdBddCtdD|dEdFddGtdH|dIddJtdK|dLdMddNdOtdP,|dQdRddStdT|dUdVddWtdX|dYdZdd[td\|d]d^dd_td`|dadbddtdc|dddeddftdg|tdh}|didjdkdltdmntD]2}|do|zdpdq|zdktdr|zs3|tdt}|dudvdwdxtdyz|S){NzH%(prog)s [OPTIONS] -o [EXCLUDE_PATTERN, ...]z:For more information, visit .aE Look recursively in for Python modules and packages and create one reST file with automodule directives per package in the . The s can be file and/or directory patterns that will be excluded from generation. Note: By default this script will not overwrite already created files.)usageepilog descriptionz --versionversion show_versionz %%(prog)s %s)actiondestr module_pathzpath to module to document)helpexclude_pattern*zGfnmatch-style file and/or directory patterns to exclude from generation)nargsrz-oz --output-dirstorer@Tzdirectory to place all output)rrrequiredrz-q store_truer>z,no output on stdout, just warnings on stderr)rrrz-dz --maxdepthrpz;maximum depth of submodules to show in the TOC (default: 4))rrtypedefaultrz-fz--forcerCzoverwrite existing filesz-lz--follow-linksrFzNfollow symbolic links. Powerful when combined with collective.recipe.omelette.)rrrrz-nz --dry-runrAz%run the script without creating filesz-ez --separateroz1put documentation for each module on its own pagez-Pz --privaterQzinclude "_private" modulesz --tocfiletocfilertz0filename of table of contents (default: modules)z-Tz--no-toc store_falsez%don't create a table of contents filez-Ez --no-headingsrSzedon't create headings for the module/package packages (e.g. when the docstrings already contain them)z-Mz--module-firstrnz7put module documentation before submodule documentationz--implicit-namespacesrzNinterpret module paths according to PEP-0420 implicit namespaces specificationz-sz--suffixr"rstzfile suffix (default: rst)z-Fz--fullfullz.generate a full project with sphinx-quickstartz-az--append-syspathappend_syspathz9append module_path to sys.path, used when --full is givenz-Hz --doc-projectrwz(project name (default: root module name)z-Az --doc-authorauthorz,project author(s), used when --full is givenz-Vz --doc-versionz*project version, used when --full is givenz-Rz --doc-releasereleasezEproject release, used when --full is given, defaults to --doc-versionzextension optionsz --extensionsr extensionsrRzenable arbitrary extensions)metavarrrrz--ext-%s append_constz sphinx.ext.%szenable %s extension)rconstrrzProject templatingz-tz --templatedir TEMPLATEDIR templatedirz%template directory for template files)rrr)argparseArgumentParserr add_argumentr intadd_argument_groupr)parsergroupexts r# get_parserr+s*  $'NOOJKK L L LF  IN .1D DFFF   <==??? )!=>>??? nW9!% ?@@BBB \ NOOQQQ l7 !!/00111 i 7 :;;=== .|*E!CDDEEE k,X GHHJJJ l<. STTVVV k,- <==???  G)Y RSSUUU jY GHHJJJ ol)!011222  .|*!011222 / 2!DEEFFF jx % <==??? h|& PQQSSS 0- [\\^^^ ogH JKKMMM nW8 NOOQQQ ogI LMMOOO ogI!<==>>>  % %b)<&=&= > >E ~|,&R0M-N-NPPPAA :+N!03!6\ "#8 9 9C ?  A A A A  % %b)=&>&> ? ?E t_m)FGGIII Mr%rargvctjtjdtjt jtddt}| |}t j |j }|j *|t jd|_ |jdr|jdd|_t j|s?t't)d|zt*j t+jd|jst3|jd |jD}t9||||j}|jrxd d lm }|!d}d}|D]%} | |dzr| }|d | zz }&id|jddddd|j d|j"pdd|j#pdd|j$p|j#pddd|jzdddddgdddd dd!dd"|j%d#|d$d%||j&d&} |j'r | d(|j'|j)rd| d'<| dddD]O} d(| vrI| d*| | d(| d(P|js#|+| d|j,|j)n#|j-rt]|||j-|jd S)*z+Parse and check the command line arguments.rvlocalesphinxNrr(rz%s is not a directory.)filec6g|]}tj|Srb)rabspath)r3rs r#rezmain..s"JJJ' W%%JJJr%r) quickstartz %s rrFdotrprojectrAuthorrrr"masterindexepubTr)zsphinx.ext.autodoczsphinx.ext.viewcodezsphinx.ext.todomakefile batchfile make_modemastertocmaxdepth mastertoctreelanguageen)rrr>r)silent overwriter)/rr setlocaleLC_ALL init_consoler6rr)r r parse_argsrrrwrhrr"rzrrBrsysstderrexitrArr@rrrr sphinx.cmdrryrrrrprrextendr>r{generaterCrr~) rrargsrr_rtqsr|r;r}drs r#mainrs MFM2... Mrw||KBBHMMM \\F   T " "D|D,--H {3nnTX..r2  {c""&k!""o :h   b)**X5CJGGGG  ; $,JJT5IJJJH8XtT5EFFG y.O//////   ' 'F  s!233  K I& &DD DL 5  3  t{  dk-X  t|)r   t|9t|9r  cDK'  g  D  ...       ! " T# $ % &$"1)   , ? 4 lO " "4? 3 3 3 : AgJ\?111% 7 7Ccz 7,&&s+++,&&syy~~666{ 6 KK$$*$($4  6 6 6 Ot|T=MNNN 1r%__main__)NNr0)rtN)8__doc__rrrr6rrrimportlib.machineryrrtypingrr r r sphinx.localerr r sphinx.cmd.quickstartrrsphinx.util.osutilrrsphinx.util.templaterenvironrhrPtupler r)rTstrboolr$r+r9rGrXrsr~rcrgrrrrrrrrr__name__rbr%r#rsK   222222............33333333,,,,,,88888888------bj(j0177<B!!!!*GI3$s)T&  3 $s)      3 $s) 3 c49d3i78$DE    2sd3ist+/3333$s)333$'33793333l c T#Y 4    ^H+^^^^B8ABB<H H tCyH CH H H H X z DFFFFF  r%