ó öÀ„\c@s+dZddlZddlmZddlmZddlmZeråddl m Z m Z m Z m Z mZmZmZmZddlmZddlmZdd lmZdd lmZdd lmZdd lmZnd efd„ƒYZdefd„ƒYZ defd„ƒYZ!dS(s' sphinx.domains ~~~~~~~~~~~~~~ Support for domains, which are groupings of description directives and roles describing e.g. constructs of one programming language. :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. iÿÿÿÿN(t iteritems(t SphinxError(t_(tAnytCallabletDicttIterabletListtTupletTypetUnion(tnodes(tInliner(tBuilder(tBuildEnvironment(tXRefRole(t RoleFunctiontObjTypecBs$eZdZidd6Zd„ZRS(s3 An ObjType is the description for a type of object that a domain can document. In the object_types attribute of Domain subclasses, object type names are mapped to instances of this class. Constructor arguments: - *lname*: localized name of the type (do not include domain name) - *roles*: all the roles that can refer to an object of this type - *attrs*: object attributes -- currently only "searchprio" is known, which defines the object's priority in the full-text search index, see :meth:`Domain.get_objects()`. it searchpriocOs8||_||_|jjƒ|_|jj|ƒdS(N(tlnametrolest known_attrstcopytattrstupdate(tselfRRR((s6lib/python2.7/site-packages/sphinx/domains/__init__.pyt__init__2s  (t__name__t __module__t__doc__RR(((s6lib/python2.7/site-packages/sphinx/domains/__init__.pyRs  tIndexcBs5eZdZdZdZdZd„Zdd„ZRS(sŒ An Index is the description for a domain-specific index. To add an index to a domain, subclass Index, overriding the three name attributes: * `name` is an identifier used for generating file names. * `localname` is the section title for the index. * `shortname` is a short name for the index, for use in the relation bar in HTML output. Can be empty to disable entries in the relation bar. and providing a :meth:`generate()` method. Then, add the index class to your domain's `indices` list. Extensions can add indices to existing domains using :meth:`~sphinx.application.Sphinx.add_index_to_domain()`. cCsD|jdks|jdkr7td|jjƒ‚n||_dS(Ns0Index subclass %s has no valid name or localname(tnametNonet localnameRt __class__Rtdomain(RR#((s6lib/python2.7/site-packages/sphinx/domains/__init__.pyRMscCs t‚dS(sReturn entries for the index given by *name*. If *docnames* is given, restrict to entries referring to these docnames. The return value is a tuple of ``(content, collapse)``, where *collapse* is a boolean that determines if sub-entries should start collapsed (for output formats that support collapsing sub-entries). *content* is a sequence of ``(letter, entries)`` tuples, where *letter* is the "heading" for the given *entries*, usually the starting letter. *entries* is a sequence of single entries, where a single entry is a sequence ``[name, subtype, docname, anchor, extra, qualifier, descr]``. The items in this sequence have the following meaning: - `name` -- the name of the index entry to be displayed - `subtype` -- sub-entry related type: 0 -- normal entry 1 -- entry with sub-entries 2 -- sub-entry - `docname` -- docname where the entry is located - `anchor` -- anchor for the entry within `docname` - `extra` -- extra info for the entry - `qualifier` -- qualifier for the description - `descr` -- description for the entry Qualifier and description are not rendered e.g. in LaTeX output. N(tNotImplementedError(Rtdocnames((s6lib/python2.7/site-packages/sphinx/domains/__init__.pytgenerateTsN( RRRR RR!t shortnameRR&(((s6lib/python2.7/site-packages/sphinx/domains/__init__.pyR:s   tDomaincBsÚeZdZdZdZiZiZiZgZiZ iZ iZ dZ dZd„Zd„Zd„Zd„Zd„Zd„Zd „Zd „Zd „Zd „Zd „Zd„Zed„Zd„Zd„ZRS(sÔ A Domain is meant to be a group of "object" description directives for objects of a similar nature, and corresponding roles to create references to them. Examples would be Python modules, classes, functions etc., elements of a templating language, Sphinx roles and directives, etc. Each domain has a separate storage for information about existing objects and how to reference them in `self.data`, which must be a dictionary. It also must implement several functions that expose the object information in a uniform way to parts of Sphinx that allow the user to reference or search for objects in a domain-agnostic way. About `self.data`: since all object and cross-referencing information is stored on a BuildEnvironment instance, the `domain.data` object is also stored in the `env.domaindata` dict under the key `domain.name`. Before the build process starts, every active domain is instantiated and given the environment object; the `domaindata` dict must then either be nonexistent or a dictionary whose 'version' key is equal to the domain class' :attr:`data_version` attribute. Otherwise, `IOError` is raised and the pickled environment is discarded. ticCs¬||_i|_i|_i|_i|_t|jƒ|_t|jƒ|_t|jƒ|_t |j ƒ|_ |j |j krØt |jtƒsŸt‚tj|jƒ}|j|d<||_|j |j R?(RRtobjtypetrole((s6lib/python2.7/site-packages/sphinx/domains/__init__.pytadd_object_typeÁs    cslˆˆjkrˆjˆSˆˆjkr-dSdˆjˆf‰ig‡‡‡fd†}|ˆjˆ<|S(sŠReturn a role adapter function that always gives the registered role its full name ('domain:name') as the first argument. s%s:%scs#ˆjˆˆ||||||ƒS(N(R(ttyptrawtextttexttlinenotinlinertoptionstcontent(tfullnameRR(s6lib/python2.7/site-packages/sphinx/domains/__init__.pyt role_adapterØsN(R,RR R(RRRQ((RPRRs6lib/python2.7/site-packages/sphinx/domains/__init__.pyRGÍs  cs}||jkr|j|S||jkr-dSd|j|f‰|j|‰dˆf‡‡fd†ƒY}||j|<|S(sŒReturn a directive adapter class that always gives the registered directive its full name ('domain:name') as ``self.name``. s%s:%stDirectiveAdaptercseZ‡‡fd†ZRS(csˆ|_ˆj|ƒS(N(Rtrun(R(t BaseDirectiveRP(s6lib/python2.7/site-packages/sphinx/domains/__init__.pyRSìs (RRRS((RTRP(s6lib/python2.7/site-packages/sphinx/domains/__init__.pyRRësN(R-R2R R(RRRR((RTRPs6lib/python2.7/site-packages/sphinx/domains/__init__.pyt directiveßs   cCsdS(s?Remove traces of a document in the domain-specific inventories.N((Rtdocname((s6lib/python2.7/site-packages/sphinx/domains/__init__.pyt clear_docõscCstd|jƒ‚dS(sˆMerge in data regarding *docnames* from a different domaindata inventory (coming from a subprocess in parallel builds). sLmerge_domaindata must be implemented in %s to be able to do parallel builds!N(R$R"(RR%t otherdata((s6lib/python2.7/site-packages/sphinx/domains/__init__.pytmerge_domaindataúscCsdS(s7Process a document after it is read by the environment.N((RR+RVtdocument((s6lib/python2.7/site-packages/sphinx/domains/__init__.pyt process_docscCsdS(s)Do consistency checks (**experimental**).N((R((s6lib/python2.7/site-packages/sphinx/domains/__init__.pytcheck_consistencyscCsdS(sxProcess a pending xref created in a doc field. For example, attach information about the current scope. N((Rtpnode((s6lib/python2.7/site-packages/sphinx/domains/__init__.pytprocess_field_xref scCsdS(sLResolve the pending_xref *node* with the given *typ* and *target*. This method should return a new node, to replace the xref node, containing the *contnode* which is the markup content of the cross-reference. If no resolution can be found, None can be returned; the xref node will then given to the :event:`missing-reference` event, and if that yields no resolution, replaced by *contnode*. The method can also raise :exc:`sphinx.environment.NoUri` to suppress the :event:`missing-reference` event being emitted. N((RR+t fromdocnametbuilderRIttargettnodetcontnode((s6lib/python2.7/site-packages/sphinx/domains/__init__.pyt resolve_xrefscCs t‚dS(s9Resolve the pending_xref *node* with the given *target*. The reference comes from an "any" or similar role, which means that we don't know the type. Otherwise, the arguments are the same as for :meth:`resolve_xref`. The method must return a list (potentially empty) of tuples ``('domain:role', newnode)``, where ``'domain:role'`` is the name of a role that could have created the same reference, e.g. ``'py:func'``. ``newnode`` is what :meth:`resolve_xref` would return. .. versionadded:: 1.3 N(R$(RR+R_R`RaRbRc((s6lib/python2.7/site-packages/sphinx/domains/__init__.pytresolve_any_xref&scCsgS(sýReturn an iterable of "object descriptions", which are tuples with five items: * `name` -- fully qualified name * `dispname` -- name to display when searching/linking * `type` -- object type, a key in ``self.object_types`` * `docname` -- the document where it is to be found * `anchor` -- the anchor name for the object * `priority` -- how "important" the object is (determines placement in search results) - 1: default priority (placed before full-text matches) - 0: object is important (placed before default-priority objects) - 2: object is unimportant (placed after full-text matches) - -1: object should not show up in search at all ((R((s6lib/python2.7/site-packages/sphinx/domains/__init__.pyt get_objects7scCs'|r |jStdƒ|j|jfS(s#Return full name for given ObjType.s%s %s(RRR=(Rttypetprimary((s6lib/python2.7/site-packages/sphinx/domains/__init__.pyt get_type_nameKscCs"|jj|jdƒ\}}|S(s,Get type of enumerable nodes (experimental).N(NN(tenumerable_nodesR@R"R (RRbtenum_node_typeR((s6lib/python2.7/site-packages/sphinx/domains/__init__.pytget_enumerable_node_typeRscCsdS(s*Return full qualified name for given node.N(R (RRb((s6lib/python2.7/site-packages/sphinx/domains/__init__.pytget_full_qualified_nameXsN(RRRRR=R1R2RR4tdangling_warningsRjR7R R;R:RRHRGRURWRYR[R\R^RdReRftFalseRiRlRm(((s6lib/python2.7/site-packages/sphinx/domains/__init__.pyR(ts6            ("RRtsixRt sphinx.errorsRt sphinx.localeRRottypingRRRRRRR R tdocutilsR tdocutils.parsers.rst.statesR tsphinx.buildersR tsphinx.environmentRt sphinx.rolesRtsphinx.util.typingRtobjectRRR((((s6lib/python2.7/site-packages/sphinx/domains/__init__.pyt s ::