σ φΐ„\c@@sζdZddlmZddlmZddlmZerddlm Z m Z m Z m Z ddl mZddlmZnd„Zd efd „ƒYZd efd „ƒYZd efd„ƒYZdefd„ƒYZdS(s8 sphinx.util.docfields ~~~~~~~~~~~~~~~~~~~~~ "Doc fields" are reST field lists in object descriptions that will be domain-specifically transformed to a more appealing presentation. :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. i(tabsolute_import(tnodes(taddnodes(tAnytDicttListtTuple(tDomain(tBuildEnvironmentcC@stt|ƒdkrtSt|ƒdkrVx+|dD]}t|tjƒs3tSq3Wnt|dtjƒrptStS(sCTrue if the node only contains one paragraph (and system messages).ii(tlentFalset isinstanceRtsystem_messaget paragraphtTrue(tnodetsubnode((s4lib/python2.7/site-packages/sphinx/util/docfields.pyt_is_single_paragraphs tFieldcB@sqeZdZeZeZddeddd„Ze j ddd„Z e j ddd„Z d„Z dd„ZRS(sΌA doc field that is never grouped. It can have an argument or not, the argument can be linked using a specified *rolename*. Field should be used for doc fields that usually don't occur more than once. The body can be linked using a specified *bodyrolename* if the content is just a single inline or text node. Example:: :returns: description of the return value :rtype: description of the return type cC@s:||_||_||_||_||_||_dS(N(tnametnamestlabelthas_argtrolenamet bodyrolename(tselfRRRRRR((s4lib/python2.7/site-packages/sphinx/util/docfields.pyt__init__7s      c C@sz|s|p|||ƒStjdd|dtd|d|ƒ}||pU|||ƒ7}|rv|j|j|ƒn|S(Ntt refdomaint refexplicittreftypet reftarget(Rt pending_xrefR tdomainstprocess_field_xref(RRtdomainttargett innernodetcontnodetenvtrefnode((s4lib/python2.7/site-packages/sphinx/util/docfields.pyt make_xrefAs cC@s|j||||||ƒgS(N(R)(RRR#R$R%R&R'((s4lib/python2.7/site-packages/sphinx/util/docfields.pyt make_xrefsSs cC@s ||fS(N((Rtfieldargtcontent((s4lib/python2.7/site-packages/sphinx/util/docfields.pyt make_entry^sc C@s?|\}}tjd|jƒ}|rh|tjdƒ7}|j|j|j||tjd|ƒƒnt|ƒdkr t|dtjƒsΦt|dtj ƒr t|dƒdkr t|ddtjƒr |j|j ||dj ƒd|dd|ƒ}ntj dtj dd|Œƒ}tjd||ƒS(NRt R'iiR&(Rt field_nameRtTexttextendR*RR R tinlineRtastextt field_bodyR tfield( RttypesR#titemR'R+R,t fieldnamet fieldbody((s4lib/python2.7/site-packages/sphinx/util/docfields.pyt make_fieldbs ,&!(N(t__name__t __module__t__doc__R t is_groupedtis_typedtNoneRRRtliteral_emphasisR)R*R-R:(((s4lib/python2.7/site-packages/sphinx/util/docfields.pyR's      t GroupedFieldcB@s>eZdZeZejZddde d„Z dd„Z RS(sΧ A doc field that is grouped; i.e., all fields of that type will be transformed into one field with its body being a bulleted list. It always has an argument. The argument can be linked using the given *rolename*. GroupedField should be used for doc fields that can occur more than once. If *can_collapse* is true, this field will revert to a Field if only used once. Example:: :raises ErrorClass: description when it is raised cC@s)tj||||t|ƒ||_dS(N(RRRt can_collapse(RRRRRRC((s4lib/python2.7/site-packages/sphinx/util/docfields.pyRŠsc C@stjd|jƒ}|jƒ}x~|D]v\}}tjƒ} | j|j|j||tj d|ƒƒ| tj dƒ7} | |7} |tj d| ƒ7}q(Wt |ƒdkrκ|j rκtjd|ddƒ} tjd|| ƒStjd|ƒ} tjd|| ƒS(NRR's -- ii(RR/Rt list_typeR R1R*RRtliteral_strongR0t list_itemR RCR4R5( RR6R#titemsR'R8tlistnodeR+R,tparR9((s4lib/python2.7/site-packages/sphinx/util/docfields.pyR:s   (N( R;R<R=RR>Rt bullet_listRDR@R RR:(((s4lib/python2.7/site-packages/sphinx/util/docfields.pyRBzs     t TypedFieldcB@s;eZdZeZddddded„Zdd„ZRS(sa A doc field that is grouped and has type information for the arguments. It always has an argument. The argument can be linked using the given *rolename*, the type using the given *typerolename*. Two uses are possible: either parameter and type description are given separately, using a field from *names* and one from *typenames*, respectively, or both are given using a field from *names*, see the example. Example:: :param foo: description of parameter foo :type foo: SomeClass -- or -- :param SomeClass foo: description of parameter foo cC@s2tj||||||ƒ||_||_dS(N(RBRt typenamest typerolename(RRRRLRRRMRC((s4lib/python2.7/site-packages/sphinx/util/docfields.pyRΎs c @sΡ‡‡‡‡fd†}tjdˆjƒ}t|ƒdkrjˆjrj|d\}}|||ƒ} nBˆjƒ} x3|D]+\}}| tjd|||ƒƒ7} q}Wtjd| ƒ} tjd|| ƒS(Nc@stjƒ}|jˆjˆjˆ|tjdˆƒƒ|ˆkrτ|tjdƒ7}ˆj|ƒ}t |ƒdkrΤt |dtjƒrΤdj d„|Dƒƒ}|jˆjˆj ˆ|tj dˆƒƒn ||7}|tjdƒ7}n|tjdƒ7}||7}|S( NR's (iiucs@s|]}|jƒVqdS(N(R3(t.0tn((s4lib/python2.7/site-packages/sphinx/util/docfields.pys Ψst)s -- (RR R1R*RRRER0tpopR R tjoinRMRA(R+R,RIt fieldtypettypename(R#R'RR6(s4lib/python2.7/site-packages/sphinx/util/docfields.pyt handle_itemΜs  (  Rii( RR/RR RCRDRFR4R5( RR6R#RGR'RUR8R+R,tbodynodeR9((R#R'RR6s4lib/python2.7/site-packages/sphinx/util/docfields.pyR:Εs #((N( R;R<R=RR?R@R RR:(((s4lib/python2.7/site-packages/sphinx/util/docfields.pyRK©s   tDocFieldTransformercB@s2eZdZd„Zd„Zd„Zd„ZRS(s Transforms field lists in "doc field" syntax into better-looking equivalents, using the field type definitions given on a domain. cC@sI||_d|jjkr9|j|jjƒ|j_n|j|_dS(Nt_doc_field_type_map(t directivet __class__t__dict__tpreprocess_fieldtypestdoc_field_typesRXttypemap(RRY((s4lib/python2.7/site-packages/sphinx/util/docfields.pyRτs cC@soi}xb|D]Z}x!|jD]}|tf||R-R_R5tstatetsettingsR'R:t replace_self(RRR^tentriest groupindicesR6R5R8R9RSR+ttypedesct is_typefieldR,t new_fieldnameR$txrefsRTROtargtypetargnamettranslatable_contenttgrouptentrytnew_listt fieldtypesR'((s4lib/python2.7/site-packages/sphinx/util/docfields.pyR`s–   "   ! (       "           (R;R<R=RR\RbR`(((s4lib/python2.7/site-packages/sphinx/util/docfields.pyRWξs   N(R=t __future__RtdocutilsRtsphinxRR ttypingRRRRtsphinx.domainsRtsphinx.environmentRRtobjectRRBRKRW(((s4lib/python2.7/site-packages/sphinx/util/docfields.pyt s" S/E