B ëBcâ<ã@sÜddlZddlZddlZddlZddlmZddlZddlmZddl m Z ddl Z ddl m Z ddlmZmZmZmZddlmZd ZGd d „d eƒZGd d „d eeƒZGdd„deeƒZGdd„deeƒZddd„ZdS)éN)ÚCallable)ÚFileSystemLoader)ÚSandboxedEnvironment)ÚBuiltinTemplateLoaderé)ÚNumpyDocStringÚ FunctionDocÚClassDocÚObjDoc)Ú make_xrefz1\b(import +matplotlib|from +matplotlib +import)\bcsÀeZdZd0dd„Zdd„Zd1dd„Zd d „Zd2d d „Zdd„Zdd„Z dd„Z d3dd„Z dd„Z dd„Z d4dd„Zdd„Zd d!„Z‡fd"d#„Zd$d%„Zd&d'„Zd(d)„Zd*d+„Zd5d.d/„Z‡ZS)6ÚSphinxDocStringNcCs*|dkr i}tj|||d| |¡dS)N)Úconfig)rÚ__init__Ú load_config)ÚselfZ docstringr ©rú8lib/python3.7/site-packages/numpydoc/docscrape_sphinx.pyrszSphinxDocString.__init__cCsª| dd¡|_| dd¡|_| dd¡|_| dd¡|_| dtƒ¡|_| dtƒ¡|_| d d¡|_ |j dkr¦t j   t j   t¡d ¡g}t|ƒ}t|d }| d ¡|_ dS) NÚ use_plotsFÚclass_members_toctreeTÚattributes_as_param_listÚxref_param_typeÚ xref_aliasesÚ xref_ignoreÚtemplateÚ templates)Úloaderznumpydoc_docstring.rst)ÚgetrrrrÚdictrÚsetrrÚosÚpathÚjoinÚdirnameÚ__file__rrÚ get_template)rr Ú template_dirsÚtemplate_loaderÚ template_envrrrrs  zSphinxDocString.load_configú`cCs d|dgS)Nz .. rubric:: Úr)rÚnameÚsymbolrrrÚ _str_header*szSphinxDocString._str_headercCsd|dgS)Nú:r)rr*rrrÚ_str_field_list-szSphinxDocString._str_field_listécCs(g}x|D]}|d||g7}q W|S)Nú r)rÚdocÚindentÚoutÚlinerrrÚ _str_indent0s zSphinxDocString._str_indentcCsdgS)Nr)r)rrrrÚ_str_signature6szSphinxDocString._str_signaturecCs|ddgS)NZSummaryr)r)rrrrÚ _str_summary9szSphinxDocString._str_summarycCs|ddgS)NzExtended Summaryr)r)rrrrÚ_str_extended_summary<sz%SphinxDocString._str_extended_summaryÚReturnscCsÖd}d}g}||rÒ|| |¡7}|dg7}x¤||D]˜}|j}|rZ|jrZt||j|jƒ}|jr€|| ||j ¡|fg¡7}n|| || ¡g¡7}|j s²|| dgd¡7}n|| |j d¡7}|dg7}q6W|S)Nz **%s** : %sz%sr)z..é) r.Útyperr rrr*r5ÚstripÚdesc)rr*Z named_fmtZ unnamed_fmtr3ÚparamÚ param_typerrrÚ _str_returns?s(  zSphinxDocString._str_returnscCsH|dd…dkr d|dd…S|dd…dkr@d|dd…S|SdS)Néz**z\*\*rÚ*z\*r)rr*rrrÚ_escape_args_and_kwargsZs z'SphinxDocString._escape_args_and_kwargsc Cs| | ¡¡}d|›d}|s&||fSt|j|dƒ}t|ƒs^t|tƒs^t |¡s^t  |¡s^d}t   |¡}|rp|sx||fSt|ddƒ}|r”|›d}nd}d|›d|›|›d}|r t   d | ¡d ¡d }t  d d  |  ¡¡¡} | rô|  d ¡ ¡}n| d¡d }|  d¡}||fS)aDetermine how to display a parameter Emulates autosummary behavior if fake_autosummary Parameters ---------- param : str The name of the parameter desc : list of str The parameter description as given in the docstring. This is ignored when autosummary logic applies. fake_autosummary : bool If True, autosummary-style behaviour will apply for params that are attributes of the class and have a docstring. Returns ------- display_param : str The marked up parameter name for display. This may include a link to the corresponding attribute's own documentation. desc : list of str A list of description lines. This may be identical to the input ``desc``, if ``autosum is None`` or ``param`` is not a class attribute, or it will be a summary of the class attribute's docstring. Notes ----- This does not have the autosummary functionality to display a method's signature, and hence is not used to format methods. It may be complicated to incorporate autosummary's signature mangling, as it relies on Sphinx's plugin mechanism. z**NÚ_namer)Ú.z:obj:`z `z\n\s*\nrrz^([A-Z].*?\.)(?:\s|$)r0Ú )rCr<ÚgetattrÚ_objÚcallableÚ isinstanceÚpropertyÚinspectZisgetsetdescriptorZismemberdescriptorÚpydocÚgetdocÚreÚsplitÚsearchr!ÚgroupÚ partition) rr>r=Úfake_autosummaryÚ display_paramÚ param_objZobj_docÚprefixZ link_prefixÚmrrrÚ_process_parambs4"        zSphinxDocString._process_paramFc CsÌg}||rÈ|| |¡7}|dg7}x¢||D]–}| |j|j|¡\}}g}|rZ| |¡|j}|rŠ|j}|jr€t||j|j ƒ}| |¡||  d  |¡g¡7}|sªdg}||  |d¡7}|dg7}q.W|S)aIGenerate RST for a listing of parameters or similar Parameter names are displayed as bold text, and descriptions are in definition lists. Parameters ---------- name : str Section name (e.g. Parameters) fake_autosummary : bool When True, the parameter names may correspond to attributes of the object beign documented, usually ``property`` instances on a class. In this case, names will be linked to fuller descriptions. Returns ------- rst : list of str r)z : z..r:) r.rYr*r=Úappendr;rr rrr5r!) rr*rTr3r>rUr=Úpartsr?rrrÚ_str_param_list°s.   zSphinxDocString._str_param_listc Csºg}||r¶|d|›dg7}t|ddƒ}|r sz3SphinxDocString._str_member_list..ú=z z ==========z %%%ds %%s z**r0css|]}| ¡VqdS)N)r<)r`Úxrrrrbsú(z) )rGÚ_replacer*r<rHrIrJrKrLZisdatadescriptorrMrNrZrÚmaxr!r=r;) rr*r3rWZautosumZothersr>rVZmaxlen_0ZhdrZfmtr=rrrÚ_str_member_listàsJ           z SphinxDocString._str_member_listcCsJg}||rF|| |¡7}t d ||¡¡ d¡}||7}|dg7}|S)NrFr))r,ÚtextwrapÚdedentr!rP)rr*r3ZcontentrrrÚ _str_sections zSphinxDocString._str_sectioncs:g}|dr6tƒ |¡}ddg}|| |dd…¡7}|S)NzSee Alsoz .. seealso::r)rA)ÚsuperÚ _str_see_alsor5)rÚ func_roler3Úsee_also)Ú __class__rrrm s  zSphinxDocString._str_see_alsocCs4g}|dr0ddg}|| |d¡7}|dg7}|S)NZWarningsz .. warning::r))r5)rr3rrrÚ _str_warnings(s  zSphinxDocString._str_warningscCs |d}g}t|ƒdkr|S|d| dd¡›g7}x\| ¡D]P\}}|dkrRq>q>|dkrr|dd |¡›g7}q>|d |›d d  |¡›g7}q>W|dg7}|S) NÚindexrz .. index:: Údefaultr)Zrefguidez single: z, z z: ú,)r_rÚitemsr!)rÚidxr3ÚsectionÚ referencesrrrÚ _str_index0s   zSphinxDocString._str_indexcCs¸g}|dr´|| d¡7}t|dtƒr6|dg|d<| |d¡|dg7}|ddg7}g}x4|dD](}t d|tj¡}|rh| | d¡¡qhW|dd  dd „|Dƒ¡dg7}|S) NZ Referencesr)z.. only:: latexz.. \[([a-z0-9._-]+)\]rz z, cSsg|]}d|›d‘qS)ú[z]_r)r`Úitemrrrú Qsz3SphinxDocString._str_references..) r,rJÚstrÚextendrOÚmatchÚIrZrRr!)rr3rur4rXrrrÚ_str_referencesAs   zSphinxDocString._str_referencescCstd |d¡}|jrft t|¡rfd|krfg}|| d¡7}|ddg7}|| |d¡7}|dg7}|S| d¡SdS)NrFZExampleszplot::z .. plot::r))r!rrOrQÚIMPORT_MATPLOTLIB_REr,r5rk)rZ examples_strr3rrrÚ _str_examplesTs   zSphinxDocString._str_examplesrÚobjcCsÔ| ¡| ¡| ¡| ¡| d¡| d¡| d¡| d¡| d¡| d¡| d¡| ¡| |¡| d¡|  ¡|  ¡|j r†|jd d d n|  d ¡|  d ¡d œ}dd„|  ¡Dƒ}|jjf|Ž}d | | d¡|¡¡S)NZ Parametersr9ZYieldsZReceiveszOther ParametersZRaisesZWarnsZNotesZ AttributesT)rTZMethods)Z signaturerrZsummaryZextended_summaryZ parametersZreturnsZyieldsZreceivesZother_parametersZraisesZwarnsÚwarningsroZnotesrxZexamplesZ attributesÚmethodscSsi|]\}}d |¡|“qS)rF)r!)r`ÚkÚvrrrú |sz+SphinxDocString.__str__..rF)r6ryr7r8r\r@rqrmrkrrƒrrhrurZrenderr!r5rP)rr2rnÚnsZrenderedrrrÚ__str__es,zSphinxDocString.__str__)N)r()r/)r9)F)rr„)Ú__name__Ú __module__Ú __qualname__rrr,r.r5r6r7r8r@rCrYr\rhrkrmrqryrrƒr‹Ú __classcell__rr)rprr s(    N 07 r c@seZdZddd„ZdS)ÚSphinxFunctionDocNcCs,|dkr i}| |¡tj||||ddS)N)r1r )rrr)rr„r1r rrrrƒs zSphinxFunctionDoc.__init__)NN)rŒrrŽrrrrrr‚src@seZdZddd„ZdS)ÚSphinxClassDocNcCs.|dkr i}| |¡tj|||d|ddS)N)r1Úfunc_docr )rr r)rr„r1r’r rrrr‹s zSphinxClassDoc.__init__)NNN)rŒrrŽrrrrrr‘Šsr‘c@seZdZddd„ZdS)Ú SphinxObjDocNcCs,|dkr i}| |¡tj||||ddS)N)r1r )rr r)rr„r1r rrrr“s zSphinxObjDoc.__init__)NN)rŒrrŽrrrrrr“’sr“cCsð|dkrs&     p