B \8(@sdZddlZddlmZddlmZGdddeZGdddeZGd d d ej ej eZ Gd d d ej ej Z Gd ddejejejZGdddejejejZGdddejejejZeZGdddejejejZGdddeZGdddejejejZGdddejejejZGdddejejejZGdddejejejZGdd d ejejejZGd!d"d"ej ej ZGd#d$d$ej ejZGd%d&d&ej ej ZGd'd(d(ej ej Z Gd)d*d*ejejejZ!Gd+d,d,ej"Z"Gd-d.d.ej#Z#Gd/d0d0e#Z$Gd1d2d2ej%ejejZ&Gd3d4d4ejejZ'Gd5d6d6ej Z(Gd7d8d8ej Z)Gd9d:d:ej Z*Gd;d<dd>ej Z-Gd?d@d@ej Z.GdAdBdBej Z/GdCdDdDej Z0GdEdFdFej Z1GdGdHdHej2ej3ej Z4GdIdJdJejej Z5GdKdLdLej6Z7GdMdNdNej6Z8GdOdPdPej9eZ:GdQdRdRej;eZe?dWdXe@ADdS)Yz sphinx.addnodes ~~~~~~~~~~~~~~~ Additional docutils nodes. :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. :license: BSD, see LICENSE for details. N)nodes)RemovedInSphinx30Warningc@s(eZdZdZddZddZddZdS) translatableaNode which supports translation. The translation goes forward with following steps: 1. Preserve original translatable messages 2. Apply translated messages from message catalog 3. Extract preserved messages (for gettext builder) The translatable nodes MUST preserve original messages. And these messages should not be overridden at applying step. Because they are used at final step; extraction. cCstdS)z(Preserve original translatable messages.N)NotImplementedError)selfr.lib/python3.7/site-packages/sphinx/addnodes.pypreserve_original_messages%sz'translatable.preserve_original_messagescCstdS)zApply translated message.N)r)roriginal_messagetranslated_messagerrrapply_translated_message*sz%translatable.apply_translated_messagecCstdS)zjExtract translation messages. :returns: list of extracted messages or messages generator N)r)rrrrextract_original_messages/sz&translatable.extract_original_messagesN)__name__ __module__ __qualname____doc__r r r rrrrrs rc@seZdZdZdZdS)not_smartquotablez+A node which does not support smart-quotes.FN)rrrrZsupport_smartquotesrrrrr8src@s(eZdZdZddZddZddZdS) toctreez Node for inserting a "TOC tree".cCs|dr|d|d<dS)Ncaption rawcaption)get)rrrrr @s z"toctree.preserve_original_messagescCs|d|kr||d<dS)Nrr)r)rr r rrrr Esz toctree.apply_translated_messagecCsd|kr|dgSgSdS)Nrr)rrrrr Js z!toctree.extract_original_messagesN)rrrrr r r rrrrr=src@seZdZdZdS)desczNode for object descriptions. This node is similar to a "definition list" with one definition. It contains one or more ``desc_signature`` and a ``desc_content``. N)rrrrrrrrrTsrc@seZdZdZdS)desc_signaturea%Node for object signatures. The "term" part of the custom Sphinx definition list. As default the signature is a single line signature, but set ``is_multiline = True`` to describe a multi-line signature. In that case all child nodes must be ``desc_signature_line`` nodes. N)rrrrrrrrr\src@seZdZdZdS)desc_signature_linezNode for a line in a multi-line object signatures. It should only be used in a ``desc_signature`` with ``is_multiline`` set. Set ``add_permalink = True`` for the line that should get the permalink. N)rrrrrrrrrgsrc@seZdZdZdS) desc_addnamez9Node for additional name parts (module name, class name).N)rrrrrrrrrqsrc@seZdZdZdS) desc_typez+Node for return types or object type names.N)rrrrrrrrrysrc@seZdZdZddZdS) desc_returnsz4Node for a "returns" annotation (a la -> in Python).cCsdtj|S)Nz -> )r TextElementastext)rrrrrszdesc_returns.astextN)rrrrrrrrrr}src@seZdZdZdS) desc_namezNode for the main object name.N)rrrrrrrrrsrc@seZdZdZdZdS)desc_parameterlistz"Node for a general parameter list.z, N)rrrrchild_text_separatorrrrrr sr c@seZdZdZdS)desc_parameterzNode for a single parameter.N)rrrrrrrrr"sr"c@seZdZdZdZddZdS) desc_optionalz6Node for marking optional parts of the parameter list.z, cCsdtj|dS)N[])rrr)rrrrrszdesc_optional.astextN)rrrrr!rrrrrr#sr#c@seZdZdZdS)desc_annotationz@Node for signature annotations (not Python 3-style annotations).N)rrrrrrrrr&sr&c@seZdZdZdS) desc_contentzrNode for object description content. This is the "definition" part of the custom Sphinx definition list. N)rrrrrrrrr'sr'c@seZdZdZdS)versionmodifiedzNode for version change entries. Currently used for "versionadded", "versionchanged" and "deprecated" directives. N)rrrrrrrrr(sr(c@seZdZdZdS)seealsozCustom "see also" admonition.N)rrrrrrrrr)sr)c@seZdZdZdS)productionlistzKNode for grammar production lists. Contains ``production`` nodes. N)rrrrrrrrr*sr*c@seZdZdZdS) productionz*Node for a single grammar production rule.N)rrrrrrrrr+sr+c@seZdZdZddZdS)mathaNode for inline equations. .. warning:: This node is provided to keep compatibility only. It will be removed in nearly future. Don't use this from your extension. .. deprecated:: 1.8 Use ``docutils.nodes.math`` instead. cCs<|dkr*d|jkr*tjdtdd|Stj||SdS)z2Special accessor for supporting ``node['latex']``.latexzrmath node for Sphinx was replaced by docutils'. Therefore please use ``node.astext()`` to get an equation instead.) stacklevelN) attributeswarningswarnrrrr, __getitem__)rkeyrrrr3s  zmath.__getitem__N)rrrrr3rrrrr,sr,c@seZdZdZddZdS) math_blockzNode for block level equations. .. warning:: This node is provided to keep compatibility only. It will be removed in nearly future. Don't use this from your extension. .. deprecated:: 1.8 cCs<|dkr*d|jkr*tjdtdd|Stj||SdS)Nr-zydisplaymath node for Sphinx was replaced by docutils'. Therefore please use ``node.astext()`` to get an equation instead.r.)r/)r0r1r2rrrr5r3)rr4rrrr3s  zmath_block.__getitem__N)rrrrr3rrrrr5sr5c@seZdZdZdS) displaymathzNode for block level equations. .. warning:: This node is provided to keep compatibility only. It will be removed in nearly future. Don't use this from your extension. .. deprecated:: 1.8 N)rrrrrrrrr6sr6c@seZdZdZdS)indexaNode for index entries. This node is created by the ``index`` directive and has one attribute, ``entries``. Its value is a list of 5-tuples of ``(entrytype, entryname, target, ignored, key)``. *entrytype* is one of "single", "pair", "double", "triple". *key* is categorization characters (usually a single character) for general index page. For the details of this, please see also: :rst:dir:`glossary` and issue #2320. N)rrrrrrrrr7s r7c@seZdZdZdS)centeredz Deprecated.N)rrrrrrrrr8sr8c@seZdZdZdS)ackszSpecial node for "acks" lists.N)rrrrrrrrr9sr9c@seZdZdZdS)hlistzjNode for "horizontal lists", i.e. lists that should be compressed to take up less vertical space. N)rrrrrrrrr: sr:c@seZdZdZdS)hlistcolz)Node for one column in a horizontal list.N)rrrrrrrrr;sr;c@seZdZdZdS)compact_paragraphz node).N)rrrrrrrrr<sr<c@seZdZdZdS)glossaryzNode to insert a glossary.N)rrrrrrrrr=sr=c@seZdZdZdS)onlyzANode for "only" directives (conditional inclusion based on tags).N)rrrrrrrrr>sr>c@seZdZdZdS) start_of_filezANode to mark start of a new file, used in the LaTeX builder only.N)rrrrrrrrr?$sr?c@seZdZdZdS) highlightlangzcInserted to set the highlight language and line number options for subsequent code blocks. N)rrrrrrrrr@(sr@c@seZdZdZdS)tabular_col_specz;Node for specifying tabular columns, used for LaTeX output.N)rrrrrrrrrA.srAc@seZdZdZdS)metazYNode for meta directive -- same as docutils' standard meta node, but pickleable. N)rrrrrrrrrB2srBc@seZdZdZdS) pending_xrefzNode for cross-references that cannot be resolved without complete information about all documents. These nodes are resolved before writing output, in BuildEnvironment.resolve_references. N)rrrrrrrrrC:srCc@seZdZdZdS)number_referencez4Node for number references, similar to pending_xref.N)rrrrrrrrrDCsrDc@seZdZdZdS)download_referencez6Node for download references, similar to pending_xref.N)rrrrrrrrrEGsrEc@seZdZdZdS)literal_emphasisz{Node that behaves like `emphasis`, but further text processors are not applied (e.g. smartypants for HTML output). N)rrrrrrrrrFKsrFc@seZdZdZdS)literal_strongzyNode that behaves like `strong`, but further text processors are not applied (e.g. smartypants for HTML output). N)rrrrrrrrrGQsrGc@seZdZdZdS) abbreviationz)Node for abbreviations with explanations.N)rrrrrrrrrHWsrHc@seZdZdZdS)manpagez Node for references to manpages.N)rrrrrrrrrI[srIccs&|]}|dkr|ddkr|VqdS)rr_Nr).0krrr asrM)Brr1ZdocutilsrZsphinx.deprecationrobjectrrZGeneralZElementrZ AdmonitionrZPartZInlinerrZFixedTextElementrrZdesc_classnamerrrr r"r#r&r'r(r)r*r+r,r5r6Z Invisibler7r8r9r:r;Z paragraphr<r=r>r?r@rASpecialZPreBibliographicrBrCZ referencerDrEZemphasisrFZstrongrGrHrIZ_add_node_class_namesglobalskeysrrrr s\  !