3
T'íc´E ã @ sÒ d Z ddlmZmZmZmZmZ ddlmZ ddl m
Z
erHddl m Z yddl m
Z W n& ek
r~ ddlmZ ej
ZY nX G dd d ejZG d
d d ejZG d d
d
ZG dd dejej
eZG dd dej
eZG dd dejej
ZG dd deejej ej Z G dd dejej ej Z G dd dejej
Z!G dd deej ej Z"G d d d eejej ej Z#G d d d eejej ej Z$e$Z%G d d! d!ejej ej Z&G d"d# d#e&Z'G d$d% d%ejej ej Z(G d&d' d'ejej ej Z)G d(d) d)ejej ej Z*G d*d+ d+ejej ej Z+G d,d- d-ej,eZ-G d.d/ d/e-Z.G d0d1 d1e-Z/G d2d3 d3e-Z0G d4d5 d5e-Z1G d6d7 d7e-Z2G d8d9 d9e-Z3G d:d; d;e-Z4G d<d= d=e-Z5G d>d? d?e-Z6e.e/e0e1e2e3e4e5e6g Z7G d@dA dAejej Z8G dBdC dCejej
Z9G dDdE dEejej
Z:G dFdG dGejej ej Z;G dHdI dIej<ej ej Z=G dJdK dKejej Z>G dLdM dMej
Z?G dNdO dOej
Z@G dPdQ dQej
ZAG dRdS dSejBZCG dTdU dUej
ZDG dVdW dWej
ZEG dXdY dYej
ZFG dZd[ d[ej
ZGG d\d] d]ej
ZHG d^d_ d_ejIejJej
Z
G d`da daej ej
ZKG dbdc dcej ej ZLG ddde deejMZNG dfdg dgejMZOG dhdi diejPeZQG djdk dkejReZSG dldm dmej ej ZTdneeUef dodpdqZVdrS )szAdditional docutils nodes.é )Ú
TYPE_CHECKINGÚAnyÚDictÚListÚSequence)Únodes)ÚElement)ÚSphinx)Úmeta)ÚMetaBodyc s. e Zd ZdZdeeeed fdd
Z ZS )Údocumentaj The document root element patched by Sphinx.
This fixes that document.set_id() does not support a node having multiple node Ids.
see https://sourceforge.net/p/docutils/patches/167/
.. important:: This is only for Sphinx internal use. Please don't use this
in your extensions. It will be removed without deprecation period.
NÚ )ÚnodeÚmsgnodeÚsuggested_prefixÚreturnc sj ddl m} |jdkr(t j|||}nt j||}|jdk rfx$|d D ]}|| jkrJ|| j|< qJW |S )Nr )Údocutilsé é Úids)r r )r r )Ú sphinx.utilr Ú__version_info__ÚsuperÚset_idr )Úselfr r r r ÚretZnode_id)Ú __class__© ú1/tmp/pip-build-gk9425m9/sphinx/sphinx/addnodes.pyr s
zdocument.set_id)Nr
)Ú__name__Ú
__module__Ú __qualname__Ú__doc__r Ústrr Ú
__classcell__r r )r r r s r c @ sB e Zd ZdZddddZeeddddZee dd d
ZdS ) Ú translatablea¯ Node 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.
N)r c C s t dS )z(Preserve original translatable messages.N)ÚNotImplementedError)r r r r Úpreserve_original_messages< s z'translatable.preserve_original_messages)Úoriginal_messageÚtranslated_messager c C s t dS )zApply translated message.N)r& )r r( r) r r r Úapply_translated_message@ s z%translatable.apply_translated_messagec C s t dS )zjExtract translation messages.
:returns: list of extracted messages or messages generator
N)r& )r r r r Úextract_original_messagesD s z&translatable.extract_original_messages) r r r! r" r' r# r* r r+ r r r r r% . s r% c @ s e Zd ZdZdZdS )Únot_smartquotablez+A node which does not support smart-quotes.FN)r r r! r" Zsupport_smartquotesr r r r r, L s r, c @ sB e Zd ZdZddddZeeddddZee dd d
ZdS ) Útoctreez Node for inserting a "TOC tree".N)r c C sJ | j dg }x"| d D ]\}}|r|j| qW | jdrF| d | d< d S )NÚ
rawentriesÚentriesÚcaptionÚ
rawcaption)Ú
setdefaultÚappendÚget)r r. ÚtitleZ_docnamer r r r' T s
z"toctree.preserve_original_messages)r( r) r c C sP x4t | d D ]$\}\}}||kr||f| d |< qW | jd|krL|| d< d S )Nr/ r1 r0 )Ú enumerater4 )r r( r) Úir5 Zdocnamer r r r* _ s
z toctree.apply_translated_messagec C s0 g }|j | jdg d| kr,|j| d |S )Nr. r1 )Úextendr4 r3 )r Úmessagesr r r r+ i s
z!toctree.extract_original_messages) r r r! r" r' r# r* r r+ r r r r r- Q s
r- c s8 e Zd ZU dZg Zee eedd fdd Z Z S )Ú_desc_classes_injectorz_Helper base class for injecting a fixes list of classes.
Use as the first base class.
N)ÚargsÚkwargsr c s" t j|| | d j| j d S )NÚclasses)r Ú__init__r8 r= )r r; r< )r r r r> s z _desc_classes_injector.__init__)
r r r! r" r= r r# r r> r$ r r )r r r: y s
r: c @ s e Zd ZdZdS )Údescam Node for a list of object signatures and a common description of them.
Contains one or more :py:class:`desc_signature` nodes
and then a single :py:class:`desc_content` node.
This node always has two classes:
- The name of the domain it belongs to, e.g., ``py`` or ``cpp``.
- The name of the object type in the domain, e.g., ``function``.
N)r r r! r" r r r r r? s
r? c s, e Zd ZdZddgZe fddZ ZS )Údesc_signatureaS Node for a single object signature.
As default the signature is a single-line signature.
Set ``is_multiline = True`` to describe a multi-line signature.
In that case all child nodes must be :py:class:`desc_signature_line` nodes.
This node always has the classes ``sig``, ``sig-object``, and the domain it belongs to.
Úsigz
sig-objectc s | j drdS t jS d S )NZ is_multilineú )r4 r Úchild_text_separator)r )r r r rC ¥ s
z#desc_signature.child_text_separator)r r r! r" r= ÚpropertyrC r$ r r )r r r@ s r@ c @ s e Zd ZdZdZdS )Údesc_signature_linezõNode for a line in a multi-line object signature.
It should only be used as a child of a :py:class:`desc_signature`
with ``is_multiline`` set to ``True``.
Set ``add_permalink = True`` for the line that should get the permalink.
r
N)r r r! r" Zsphinx_line_typer r r r rE s rE c @ s e Zd ZdZdS )Ú desc_contentzfNode for object description content.
Must be the last child node in a :py:class:`desc` node.
N)r r r! r" r r r r rF · s rF c s4 e Zd ZdZddgZeeedd fdd Z ZS )Ú desc_inlinezâNode for a signature fragment in inline text.
This is for example used for roles like :rst:role:`cpp:expr`.
This node always has the classes ``sig``, ``sig-inline``,
and the name of the domain it belongs to.
rA z
sig-inlineN)Údomainr; r< r c s t j|| | d j| d S )Nr= )r r> r3 )r rH r; r< )r r r r> È s zdesc_inline.__init__) r r r! r" r= r# r r> r$ r r )r r rG ¾ s rG c @ s e Zd ZdZddgZdS )Ú desc_namezÄNode for the main object name.
For example, in the declaration of a Python class ``MyModule.MyClass``,
the main name is ``MyClass``.
This node always has the class ``sig-name``.
zsig-nameZdescnameN)r r r! r" r= r r r r rI Ò s rI c @ s e Zd ZdZddgZdS )Ú desc_addnamezãNode for additional name parts for an object.
For example, in the declaration of a Python class ``MyModule.MyClass``,
the additional name part is ``MyModule.``.
This node always has the class ``sig-prename``.
z sig-prenameZ
descclassnameN)r r r! r" r= r r r r rJ Ý s rJ c @ s e Zd ZdZdS )Ú desc_typez+Node for return types or object type names.N)r r r! r" r r r r rK í s rK c s& e Zd ZdZed fdd Z ZS )Ú desc_returnsz4Node for a "returns" annotation (a la -> in Python).)r c s dt j S )Nz -> )r Úastext)r )r r r rM ô s zdesc_returns.astext)r r r! r" r# rM r$ r r )r r rL ñ s rL c s$ e Zd ZdZdZ fddZ ZS )Údesc_parameterlistz"Node for a general parameter list.z, c s dj t j S )Nz({}))Úformatr rM )r )r r r rM ü s zdesc_parameterlist.astext)r r r! r" rC rM r$ r r )r r rN ø s rN c @ s e Zd ZdZdS )Údesc_parameterz Node for a single parameter.N)r r r! r" r r r r rP s rP c s* e Zd ZdZdZed fdd Z ZS )Ú
desc_optionalz6Node for marking optional parts of the parameter list.z, )r c s dt j d S )Nú[ú])r rM )r )r r r rM s zdesc_optional.astext)r r r! r" rC r# rM r$ r r )r r rQ s rQ c @ s e Zd ZdZdS )Údesc_annotationz@Node for signature annotations (not Python 3-style annotations).N)r r r! r" r r r r rT s rT c s> e Zd ZU dZg Zee deeeedd fdd
Z Z
S )Údesc_sig_elementz<Common parent class of nodes for inline text of a signature.r
N)Ú rawsourceÚtextÚchildrenÚ
attributesr c s* t j||f|| | d j| j d S )Nr= )r r> r8 r= )r rV rW rX rY )r r r r> s zdesc_sig_element.__init__)r
r
) r r r! r" r= r r# r r r> r$ r r )r r rU s
rU c s6 e Zd ZdZdgZd eeeedd fdd
Z Z S )
Údesc_sig_spacez Node for a space in a signature.Úwr
rB N)rV rW rX rY r c s t j||f|| d S )N)r r> )r rV rW rX rY )r r r r> ( s zdesc_sig_space.__init__)r
rB )
r r r! r" r= r# r r r> r$ r r )r r rZ $ s rZ c @ s e Zd ZdZdgZdS )Ú
desc_sig_namez&Node for an identifier in a signature.ÚnN)r r r! r" r= r r r r r\ - s r\ c @ s e Zd ZdZdgZdS )Údesc_sig_operatorz$Node for an operator in a signature.ÚoN)r r r! r" r= r r r r r^ 2 s r^ c @ s e Zd ZdZdgZdS )Údesc_sig_punctuationz$Node for punctuation in a signature.ÚpN)r r r! r" r= r r r r r` 7 s r` c @ s e Zd ZdZdgZdS )Údesc_sig_keywordz*Node for a general keyword in a signature.ÚkN)r r r! r" r= r r r r rb < s rb c @ s e Zd ZdZdgZdS )Údesc_sig_keyword_typez;Node for a keyword which is a built-in type in a signature.ZktN)r r r! r" r= r r r r rd A s rd c @ s e Zd ZdZdgZdS )Údesc_sig_literal_numberz*Node for a numeric literal in a signature.ÚmN)r r r! r" r= r r r r re F s re c @ s e Zd ZdZdgZdS )Údesc_sig_literal_stringz)Node for a string literal in a signature.ÚsN)r r r! r" r= r r r r rg K s rg c @ s e Zd ZdZdgZdS )Údesc_sig_literal_charz,Node for a character literal in a signature.ZscN)r r r! r" r= r r r r ri P s ri c @ s e Zd ZdZdS )ÚversionmodifiedzNode for version change entries.
Currently used for "versionadded", "versionchanged" and "deprecated"
directives.
N)r r r! r" r r r r rj ` s rj c @ s e Zd ZdZdS )Úseealsoz Custom "see also" admonition.N)r r r! r" r r r r rk h s rk c @ s e Zd ZdZdS )ÚproductionlistzKNode for grammar production lists.
Contains ``production`` nodes.
N)r r r! r" r r r r rl l s rl c @ s e Zd ZdZdS )Ú
productionz*Node for a single grammar production rule.N)r r r! r" r r r r rm s s rm c @ s e Zd ZdZdS )ÚindexaÈ Node 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)r r r! r" r r r r rn y s rn c @ s e Zd ZdZdS )Úcenteredz Deprecated.N)r r r! r" r r r r ro s ro c @ s e Zd ZdZdS )Úacksz Special node for "acks" lists.N)r r r! r" r r r r rp s rp c @ s e Zd ZdZdS )ÚhlistzjNode for "horizontal lists", i.e. lists that should be compressed to
take up less vertical space.
N)r r r! r" r r r r rq s rq c @ s e Zd ZdZdS )Úhlistcolz)Node for one column in a horizontal list.N)r r r! r" r r r r rr s rr c @ s e Zd ZdZdS )Úcompact_paragraphz<Node for a compact paragraph (which never makes a <p> node).N)r r r! r" r r r r rs s rs c @ s e Zd ZdZdS )ÚglossaryzNode to insert a glossary.N)r r r! r" r r r r rt s rt c @ s e Zd ZdZdS )ÚonlyzANode for "only" directives (conditional inclusion based on tags).N)r r r! r" r r r r ru ¢ s ru c @ s e Zd ZdZdS )Ú
start_of_filezANode to mark start of a new file, used in the LaTeX builder only.N)r r r! r" r r r r rv ¨ s rv c @ s e Zd ZdZdS )Ú
highlightlangzcInserted to set the highlight language and line number options for
subsequent code blocks.
N)r r r! r" r r r r rw ¬ s rw c @ s e Zd ZdZdS )Útabular_col_specz;Node for specifying tabular columns, used for LaTeX output.N)r r r! r" r r r r rx ² s rx c @ s e Zd ZdZdZdS )r
zYNode for meta directive -- same as docutils' standard meta node,
but pickleable.
N)r r r! r" Z
rawcontentr r r r r
¶ s r
c @ s e Zd ZdZdZdS )Ú pending_xrefzÍNode for cross-references that cannot be resolved without complete
information about all documents.
These nodes are resolved before writing output, in
BuildEnvironment.resolve_references.
r
N)r r r! r" rC r r r r ry ¿ s ry c @ s e Zd ZdZdS )Úpending_xref_conditiona} Node for cross-references that are used to choose appropriate
content of the reference by conditions on the resolving phase.
When the :py:class:`pending_xref` node contains one or more
**pending_xref_condition** nodes, the cross-reference resolver
should choose the content of the reference using defined conditions
in ``condition`` attribute of each pending_xref_condition nodes::
<pending_xref refdomain="py" reftarget="io.StringIO ...>
<pending_xref_condition condition="resolved">
<literal>
StringIO
<pending_xref_condition condition="*">
<literal>
io.StringIO
After the processing of cross-reference resolver, one of the content node
under pending_xref_condition node is chosen by its condition and to be
removed all of pending_xref_condition nodes::
# When resolved the cross-reference successfully
<reference>
<literal>
StringIO
# When resolution is failed
<reference>
<literal>
io.StringIO
.. note:: This node is only allowed to be placed under pending_xref node.
It is not allows to place it under other nodes. In addition,
pending_xref node must contain only pending_xref_condition
nodes if it contains one or more pending_xref_condition nodes.
The pending_xref_condition node should have **condition** attribute.
Domains can be store their individual conditions into the attribute to
filter contents on resolving phase. As a reserved condition name,
``condition="*"`` is used for the fallback of resolution failure.
Additionally, as a recommended condition name, ``condition="resolved"``
is used for the representation of resolstion success in the intersphinx
module.
.. versionadded:: 4.0
N)r r r! r" r r r r rz É s -rz c @ s e Zd ZdZdS )Únumber_referencez4Node for number references, similar to pending_xref.N)r r r! r" r r r r r{ ù s r{ c @ s e Zd ZdZdS )Údownload_referencez6Node for download references, similar to pending_xref.N)r r r! r" r r r r r| ý s r| c @ s e Zd ZdZdS )Úliteral_emphasisz{Node that behaves like `emphasis`, but further text processors are not
applied (e.g. smartypants for HTML output).
N)r r r! r" r r r r r} s r} c @ s e Zd ZdZdS )Úliteral_strongzyNode that behaves like `strong`, but further text processors are not
applied (e.g. smartypants for HTML output).
N)r r r! r" r r r r r~ s r~ c @ s e Zd ZdZdS )Úmanpagez Node for references to manpages.N)r r r! r" r r r r r
s r r )Úappr c C s¤ ddl m} | jt | jt | jt | jt | jt | jt | jt | jt
| jt | jt | jt
| jt | jt | jt xtD ]}| j| qW | jt | jt | jt | jt | jt | jt | jt | jt | jt | jt | jt | jt | jt | jt | jt | jt! | jt" | jt# | jt$ | jt% | jt& |j'dk r| jt( ddddS )Nr )r é ÚbuiltinT)ÚversionZparallel_read_safeZparallel_write_safe)r r ))r r Úadd_noder- r? r@ rE rF rG rI rJ rK rL rN rP rQ rT Ú SIG_ELEMENTSrj rk rl rm rn ro rp rq rr rs rt ru rv rw rx ry r{ r| r} r~ r r r
)r r r] r r r Úsetup sV
r N)Wr" Útypingr r r r r r r Zdocutils.nodesr Zsphinx.applicationr r
Z
docutils_metaÚ ImportErrorZ$docutils.parsers.rst.directives.htmlr r ÚNoder% r, ZGeneralr- r: Z
Admonitionr? ZPartZInlineZ TextElementr@ ZFixedTextElementrE rF rG rI rJ Zdesc_classnamerK rL rN rP rQ rT ÚinlinerU rZ r\ r^ r` rb rd re rg ri r
rj rk rl rm Z Invisiblern ro rp rq rr Z paragraphrs rt ru rv rw rx ÚSpecialZPreBibliographicry rz Ú referencer{ r| Zemphasisr} Ústrongr~ r r# r r r r r Ú<module> s (
0