\c @swdZddlmZddlZddlZddlZddlZddlZddlZddl Z ddl m Z m Z ddl mZddlZddlmZddlmZddlmZmZdd lmZdd lmZdd lmZdd lmZdd lmZddlm Z!e"rddl#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)ddl m*Z*ddlm+Z+ddl,m-Z-ddl.m/Z/ddl0m1Z1nde2fdYZ3dZ4dZ5dZ6ddZ7dde6e5ddde"dd Z9dZ:dddZ;ddd Z<d!Z=e j>d"d#Z?e@d$krse?ndS(%s" sphinx.ext.autosummary.generate ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Usable as a library or script to generate automatic RST source files for items referred to in autosummary:: directives. Each generated RST file contains a single auto*:: directive which extracts the docstring of the referred item. Example Makefile rule:: generate: sphinx-autogen -o source/generated source/*.rst :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. i(tprint_functionN(tFileSystemLoadertTemplateNotFound(tSandboxedEnvironment(t__display_version__(t package_dir(timport_by_nametget_documenter(tBuiltinTemplateLoader(t__(tSphinxComponentRegistry(t safe_getattr(t ensuredir(tescape(tAnytCallabletDicttListtTupletType(t BaseLoader(taddnodes(tBuilder(tBuildEnvironment(t DocumentertDummyApplicationcBseZdZdZRS(s3Dummy Application class for sphinx-autogen command.cCst|_dS(N(R tregistry(tself((s>lib/python2.7/site-packages/sphinx/ext/autosummary/generate.pyt__init__9s(t__name__t __module__t__doc__R(((s>lib/python2.7/site-packages/sphinx/ext/autosummary/generate.pyR6sc Csddlm}m}m}m}m}m}m}m}||||||||g} x$| D]} |j j | j | q_WdS(Ni(tModuleDocumentertClassDocumentertExceptionDocumentertDataDocumentertFunctionDocumentertMethodDocumentertAttributeDocumentertInstanceAttributeDocumenter( tsphinx.ext.autodocR R!R"R#R$R%R&R'Rtadd_documentertobjtype( tappR R!R"R#R$R%R&R't documenterst documenter((s>lib/python2.7/site-packages/sphinx/ext/autosummary/generate.pytsetup_documenters>s :    cCst|dS(N(tprint(tmsg((s>lib/python2.7/site-packages/sphinx/ext/autosummary/generate.pyt _simple_infoNscCstd|dtjdS(Ns WARNING: tfile(R/tsyststderr(R0((s>lib/python2.7/site-packages/sphinx/ext/autosummary/generate.pyt _simple_warnSst=cCs1d|krtdn|d|t|S(Ns sCan only underline single lines(t ValueErrortlen(ttitletline((s>lib/python2.7/site-packages/sphinx/ext/autosummary/generate.pyt _underlineXs s.rstc "s9tt|} t| dkr@| d dg| d} n|tddj| |rz|td|n|dk rg|D]} tjj|| ^q}nd} tjjtdd d g} d} |dk rt } | j |d | n%|r| j d |nt | } t d | }t|jdlib/python2.7/site-packages/sphinx/ext/autosummary/generate.pyt get_memberss ! (tmoduletmemberstfunctionROt functionst all_functionstclasstclassest all_classest exceptiont exceptionstall_exceptionstinherited_memberstmethodRtmethodst all_methodst attributet attributestall_attributest.iitfullnametobjnameRQR*R6t output_dirtsuffixtwarntinfot base_pathtbuildert template_dirR+(RbRe('tlisttsortedR8R tjoinRItostpathRRtinittinsertRRR;tfilterst rst_escapetfind_autosummary_in_filestsettstrtabspathR Rt ImportErrortisfileRJtopenRt get_templateR*RtTrueRFt__dict__tkeystsplittrendertwritetgenerate_autosummary_docs("tsourcesRkRlRmRnRoRpRqtimported_membersR+tshowed_sourcestfilenamet template_dirsttemplate_loadert template_envRPt new_filesRQRvt template_nameRLtparenttmod_nameRBtfntftdocttemplateRUtnstpartstcls_nametobj_nametrendered((R+s>lib/python2.7/site-packages/sphinx/ext/autosummary/generate.pyRas  +       (      ##&)#        c Csmg}x`|D]X}tj|ddddd2}|jj}|jt|d|WdQXq W|S(s^Find out what items are documented in source/*.rst. See `find_autosummary_in_lines`. trtencodingsutf-8terrorstignoreRN(tcodecsRtreadt splitlinestextendtfind_autosummary_in_lines(t filenamest documentedRRtlines((s>lib/python2.7/site-packages/sphinx/ext/autosummary/generate.pyR{s  #c CsyGt|\}}}}tj|j}t|d|d|SWnUtk rZnEtk r}td||fntk rtd|nXgS(snFind out what items are documented in the given object's docstring. See `find_autosummary_in_lines`. RVRsFailed to import '%s': %ss_Failed to import '%s'; the module executes module level statement and it might call sys.exit().( RtpydoctgetdocRRRGRR/t SystemExit( RQRVRt real_nameRLRtmodnameRRB((s>lib/python2.7/site-packages/sphinx/ext/autosummary/generate.pytfind_autosummary_in_docstrings   cCstjd}tjd}tjd}tjd}tjd}tjd}g} d} d} |} t} d}x |D]}| r|j|}|r|jd} |rtjjtjj || } qqn|j|}|r|jdj } qn|j j d r0qn|j|}|r|jdj }|j d rv|d}n| r|j | d  rd | |f}n| j || | fqn|j s|j |d rqnt} n|j|}|r*t } |jd}d} d} qn|j|}|rs|jdj } | jt| d|qn|j|}|r|jd} qqqW| S(sFind out what items appear in autosummary:: directives in the given lines. Returns a list of (name, toctree, template) where *name* is a name of an object and *toctree* the :toctree: path of the corresponding autosummary directive (relative to the root of the file name), and *template* the value of the :template: option. *toctree* and *template* ``None`` if the directive does not have the corresponding options set. s^(\s*)\.\.\s+autosummary::\s*s.^\s*\.\.\s+automodule::\s*([A-Za-z0-9_.]+)\s*$s4^\s*\.\.\s+(current)?module::\s*([a-zA-Z0-9_.]+)\s*$s%^\s+(~?[_a-zA-Z][a-zA-Z0-9_.]*)\s*.*?s^\s+:toctree:\s*(.*?)\s*$s^\s+:template:\s*(.*?)\s*$tit:t~Rhs%s.%st RiN(tretcompileRItFalsetmatchtgroupRuRvRttdirnametstripRKRJRtsearchRR(RRVRtautosummary_ret automodule_ret module_retautosummary_item_rettoctree_arg_rettemplate_arg_reRttoctreeRtcurrent_moduletin_autosummaryt base_indentR:tmRQ((s>lib/python2.7/site-packages/sphinx/ext/autosummary/generate.pyRsx          c Cs"tjdddtddtd}|jddd d d d d t|jd dddtd|jddddd ddtd|jddddd ddddtd|jddddd ddddtd |jd!d"dd#d d$dtdtd%|S(&Ntusages#%(prog)s [OPTIONS] ...tepilogs5For more information, visit .t descriptions Generate ReStructuredText using autosummary directives. sphinx-autogen is a frontend to sphinx.ext.autosummary.generate. It generates the reStructuredText files from the autosummary directives contained in the given input files. The format of the autosummary directive is documented in the ``sphinx.ext.autosummary`` Python module and can be read using:: pydoc sphinx.ext.autosummary s --versiontactiontversiontdestt show_versions %%(prog)s %st source_filetnargst+thelps&source files to generate rST files fors-os --output-dirtstoreRks directory to place all output ins-ss--suffixRltdefaulttrsts/default suffix for files (default: %(default)s)s-ts --templatesR>s0custom template directory (default: %(default)s)s-is--imported-memberst store_trueRs0document imported members (default: %(default)s)(targparsetArgumentParserR t add_argumentRRIR(tparser((s>lib/python2.7/site-packages/sphinx/ext/autosummary/generate.pyt get_parserns,          ic Cstjjtjdtjjtjjtddt }t |t j |}t |j|jd|jd|jd|jd|dS(NRtlocaletsphinxRhRqRR+(RRt setlocaletLC_ALLt init_consoleRuRvRtRRR.Rt parse_argsRRRkRlR>R(targvR+targs((s>lib/python2.7/site-packages/sphinx/ext/autosummary/generate.pytmains"     t__main__(ARt __future__RRRRRuRRR3tjinja2RRtjinja2.sandboxRt sphinx.localeRRRtsphinx.ext.autosummaryRRtsphinx.jinja2glueRR tsphinx.registryR tsphinx.util.inspectR tsphinx.util.osutilR tsphinx.util.rstR RzRttypingRRRRRRRRtsphinx.buildersRtsphinx.environmentRR(RtobjectRR.R1R5R;RIRR{RRRRRR(((s>lib/python2.7/site-packages/sphinx/ext/autosummary/generate.pytsV        .      W +