ó öÀ„\c@sdZddlmZddlZddlZddlZddlZddlZddlmZddlm Z ddl m Z ddl Z ddl mZmZddlmZdd l mZdd lmZdd lmZmZmZerdd lmZmZmZnd ejkr=ejd jdƒZ ndddgZ dZ!e"ddgƒZ#d„Z$d„Z%e&d„Z'dd„Z)d„Z*gd„Z+dd„Z,gd„Z-d„Z.d„Z/d „Z0ej1d!d"„Z2e3d#krÿe2ƒndS($s sphinx.ext.apidoc ~~~~~~~~~~~~~~~~~ Parses a directory tree looking for Python modules and packages and creates ReST files appropriately to create code documentation with Sphinx. It also creates a modules index (named modules.). This is derived from the "sphinx-autopackage" script, which is: Copyright 2008 Société des arts technologiques (SAT), https://sat.qc.ca/ :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. iÿÿÿÿ(tprint_functionN(tfnmatch(tpath(t binary_type(t__display_version__t package_dir(t EXTENSIONS(t__(trst(tFileAvoidWritet ensuredirtwalk(tAnytListtTupletSPHINX_APIDOC_OPTIONSt,tmemberss undoc-memberssshow-inheritances __init__.pys.pys.pyxcCs0|r&|}|r,|d|7}q,n|}|S(s#Join package and module with a dot.t.((tpackagetmoduletname((s0lib/python2.7/site-packages/sphinx/ext/apidoc.pytmakename8s cCs­tj|jd||jfƒ}|jrCttdƒ|ƒdS|j rstj|ƒrsttdƒ|ƒn6ttdƒ|ƒt |ƒ}|j |ƒWdQXdS(s0Write the output file for module/package .s%s.%ssWould create file %s.Ns!File %s already exists, skipping.sCreating file %s.( RtjointdestdirtsuffixtdryruntprintRtforcetisfileR twrite(Rttexttoptstfnametf((s0lib/python2.7/site-packages/sphinx/ext/apidoc.pyt write_fileEs" cCsG|rtj|ƒ}ndddg|dt|ƒ}d||fS(s2Create a heading of [1, 2 or 3 supported].t=t-t~is%s %s (Rtescapetlen(tlevelRR't underlining((s0lib/python2.7/site-packages/sphinx/ext/apidoc.pytformat_headingTs!cCs6dt||ƒ}xtD]}|d|7}qW|S(s4Create the automodule directive and add the options.s.. automodule:: %s s :%s: (RtOPTIONS(RRt directivetoption((s0lib/python2.7/site-packages/sphinx/ext/apidoc.pytformat_directive]s cCsU|jstdd|ƒ}nd}|t||ƒ7}tt||ƒ||ƒdS(s.Build the text of the file and write the file.is %s moduletN(t noheadingsR+R/R#R(RRR R((s0lib/python2.7/site-packages/sphinx/ext/apidoc.pytcreate_module_filefs  cCsÎtd|sdndt||ƒƒ}|jrX| rX|t||ƒ7}|d7}ng|D]-} ttj|| tƒ||ƒs_| ^q_}|rð|tddƒ7}|d7}x+|D]#} |dt||ƒ| f7}q¼W|d7}ng|D]D} ttj|| ƒ||ƒ r÷| tkr÷tj| ƒd ^q÷} | rw|tdd ƒ7}|j rø|d7}xú| D]}} t|t|| ƒƒ} |d | 7}|j s¿tdd | ƒ} nd } | tt|| ƒ|ƒ7} t | | |ƒqtWnrxo| D]g} t|t|| ƒƒ} |j s@|tdd | ƒ7}n|tt|| ƒ|ƒ7}|d7}qÿW|d7}n|j r±| r±|tddƒ7}|t||ƒ7}nt t||ƒ||ƒdS(s.Build the text of the file and write the file.is %s packages %s namespaces it Subpackagess.. toctree:: s %s.%s it Submoduless %s s %s moduleR0sModule contentsN( R+Rt modulefirstR/t shall_skipRRtINITPYtsplitexttseparatemodulesR1R#(troottmaster_packagetsubroottpy_filesR tsubst is_namespacetexcludesRtsubtsubmodstsubmodtmodfiletfiletext((s0lib/python2.7/site-packages/sphinx/ext/apidoc.pytcreate_package_filersR  -  !  %         tmodulescCs™tdd|jdtƒ}|d7}|d|j7}|jƒd}x;|D]3}|j|dƒrmqNn|}|d|7}qNWt|||ƒd S( sCreate the module's index.is%sR's .. toctree:: s :maxdepth: %s R0Rs %s N(R+theadertFalsetmaxdepthtsortt startswithR#(RGR RRt prev_moduleR((s0lib/python2.7/site-packages/sphinx/ext/apidoc.pytcreate_modules_toc_file®s   cCsÞ|j rtj|ƒ rtStjj|ƒtkr¢t}tj|ƒ}xGtjtj |dƒƒD]*}t tj ||ƒ|ƒsgt }qgqgW|r¢tSntj|ƒ}|dkrÚ|j dƒrÚ|j rÚtSt S(s%Check if we want to skip this module.s*.pys __init__.pyt_(timplicit_namespacesRtexiststTruetostbasenameR7tdirnametglobRt is_excludedRIRLtincludeprivate(RR R@t all_skippedt basemodulet submoduletfilename((s0lib/python2.7/site-packages/sphinx/ext/apidoc.pyR6Ás"  c s™t|dtƒ}t|dtƒ}t|dtƒ}ttj|ƒksQ|rj|jtjƒd}nd }g}xt |d|ƒD]\‰}} t ‡‡fd†| Dƒƒ} t| k} t| koÒ|} | rû| j tƒ| j dtƒnˆ|kr|s|2q‰qn|r)d ‰nd ‰t ‡‡‡fd †|Dƒƒ|(| s^| r|s’t | ƒd ks’ttjˆtƒ|ƒ r‘ˆt |ƒjtjƒjtjdƒ} | sÖt | ƒdkrtˆ|| | ||| ˆƒ|jt|| ƒƒqq‘q‰ˆ|kr,|d ks2t‚x\| D]T}ttj||ƒ|ƒs9tj|ƒd}t|||ƒ|j|ƒq9q9Wq‰W|S(s` Look for every file in the directory tree and create the corresponding ReST files. t followlinksRXRPiÿÿÿÿc3sJ|]@}tj|ƒdtkrttjˆ|ƒˆƒ r|VqdS(iN(RR8t PY_SUFFIXESRWR(t.0R"(R@R:(s0lib/python2.7/site-packages/sphinx/ext/apidoc.pys ðsiRROc3sA|]7}|jˆƒ rttjˆ|ƒˆƒ r|VqdS(N(RLRWRR(R_RA(texclude_prefixesR@R:(s0lib/python2.7/site-packages/sphinx/ext/apidoc.pys siN(R(RRO(tgetattrRIR7RStlistdirtsplitRtseptNoneR tsortedtremovetinsertR(R6RtlstriptreplaceRFtappendRtAssertionErrorR8R2(trootpathR@R R]RXRPt root_packaget toplevelsR>tfilesR=tis_pkgR?t subpackagetpy_fileR((R`R@R:s0lib/python2.7/site-packages/sphinx/ext/apidoc.pyt recurse_treeÜsJ"     # 4  cCs(x!|D]}t||ƒrtSqWtS(sÄCheck 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". (RRRRI(R:R@texclude((s0lib/python2.7/site-packages/sphinx/ext/apidoc.pyRWs cCsütjdddtdƒdtdƒƒ}|jddd d d d d tƒ|jd dtdƒƒ|jddddtdƒƒ|jddddd ddtdtdƒƒ|jddddd ddtdddtd ƒƒ|jd!d"dd#d d$dtd%ƒƒ|jd&d'dd#d d(dtdtd)ƒƒ|jd*d+dd#d d,dtd-ƒƒ|jd.d/dd#d d0dtd1ƒƒ|jd2d3dd#d d4dtd5ƒƒ|jd6ddd d7dd8dtd9ƒƒ|jd:d;dd<d d7dtd=ƒƒ|jd>d?dd#d d@dtdAƒƒ|jdBdCdd#d dDdtdEƒƒ|jdFdd#d dGdtdHƒƒ|jdIdJddd dKddLdtdMƒƒ|jdNdOdd#d dPdtdQƒƒ|jdRdSdd#d dTdtdUƒƒ|jdVdWddd dXdtdYƒƒ|jdZd[ddd d\dtd]ƒƒ|jd^d_ddd d dtd`ƒƒ|jdadbddd dcdtddƒƒ|jtdeƒƒ}xEt D]=}|jdf|ddgdhdi|d djdtdkƒ|ƒq·W|S(lNtusagesH%(prog)s [OPTIONS] -o [EXCLUDE_PATTERN, ...]tepilogs5For more information, visit .t descriptionsE 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.s --versiontactiontversiontdestt show_versions %%(prog)s %st module_paththelpspath to module to documenttexclude_patterntnargst*sGfnmatch-style file and/or directory patterns to exclude from generations-os --output-dirtstoreRtrequiredsdirectory to place all outputs-ds --maxdepthRJttypetdefaultis;maximum depth of submodules to show in the TOC (default: 4)s-fs--forcet store_trueRsoverwrite existing filess-ls--follow-linksR]sNfollow symbolic links. Powerful when combined with collective.recipe.omelette.s-ns --dry-runRs%run the script without creating filess-es --separateR9s1put documentation for each module on its own pages-Ps --privateRXsinclude "_private" moduless --tocfilettocfileRGs0filename of table of contents (default: modules)s-Ts--no-toct store_falses%don't create a table of contents files-Es --no-headingsR1sedon't create headings for the module/package packages (e.g. when the docstrings already contain them)s-Ms--module-firstR5s7put module documentation before submodule documentations--implicit-namespacesRPsNinterpret module paths according to PEP-0420 implicit namespaces specifications-ss--suffixRRsfile suffix (default: rst)s-Fs--fulltfulls.generate a full project with sphinx-quickstarts-as--append-syspathtappend_syspaths9append module_path to sys.path, used when --full is givens-Hs --doc-projectRHs(project name (default: root module name)s-As --doc-authortauthors,project author(s), used when --full is givens-Vs --doc-versions*project version, used when --full is givens-Rs --doc-releasetreleasesEproject release, used when --full is given, defaults to --doc-versionsextension optionss--ext-%st append_consttconsts sphinx.ext.%st extensionssenable %s extension( targparsetArgumentParserRt add_argumentRRRtintRItadd_argument_groupR(tparsertgrouptext((s0lib/python2.7/site-packages/sphinx/ext/apidoc.pyt get_parser*s‚                             ic 'Cs„tjjtjdƒtjjtjjtdƒdƒt ƒ}|j |ƒ}tj |j ƒ}|j d)kr|jtjƒd|_ n|jjdƒr²|jd|_ntj|ƒsîttdƒ|dtjƒtjdƒn|jst|jƒng|jD]}tj |ƒ^q}t|||ƒ}|jradd lm }|j!ƒd}d} x;|D]3} | j|dƒr“qtn| }| d | 7} qtWt"d |jd t#d dd|j d|j$pÛdd|j%pêdd|j&p|j%pddd|jdddt'ddddgdt'dt'dt'd|j(d | d!d"d#|d$|j)ƒ} |j*r†| dj+|j*ƒnt,|j t-ƒr²| dj.d%ƒ| dsL         <   A YN