HEX
Server: Apache
System: Linux pdx1-shared-a1-38 6.6.104-grsec-jammy+ #3 SMP Tue Sep 16 00:28:11 UTC 2025 x86_64
User: mmickelson (3396398)
PHP: 8.1.31
Disabled: NONE
$ pwd: /usr/lib/python3/dist-packages/sphinx/__pycache__/
Upload Files
File: //usr/lib/python3/dist-packages/sphinx/__pycache__/application.cpython-310.pyc
o

�+�a\��@s`dZddlZddlZddlZddlZddlZddlmZddlm	Z	ddlm
Z
ddlmZm
Z
mZmZmZmZmZmZmZmZddlmZddlmZmZdd	lmZdd
lmZmZddl m!Z!ddl"m#Z#ddl$Z$dd
l$m%Z%m&Z&ddl'm(Z(ddl)m*Z*ddl+m,Z,m-Z-ddl.m/Z/ddl0m1Z1ddl2m3Z3m4Z4m5Z5ddl6m7Z7ddl8m9Z9ddl:m;Z;ddl<m=Z=ddl>m?Z?ddl@mAZAddlBmCZCddlDmEZEddlFmZmGZGmHZHddlImJZJddlKmLZLddlMmNZNdd lOmPZPdd!lQmRZRmSZSmTZTdd"lUmVZVdd#lWmXZXmYZYe
�rdd$lmZZZdd%l[m\Z\d&Z]d'Z^eG�_e`�ZaGd(d)�d)�ZbGd*d+�d+�ZcdS),a
    sphinx.application
    ~~~~~~~~~~~~~~~~~~

    Sphinx application class and extensibility interface.

    Gracefully adapted from the TextPress system by Armin.

    :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.
�N)�deque)�StringIO)�path)
�IO�
TYPE_CHECKING�Any�Callable�Dict�List�Optional�Tuple�Type�Union)�nodes)�Element�TextElement)�Parser)�	Directive�roles)�	Transform)�Lexer)�locale�package_dir)�Config)�RemovedInSphinx60Warning)�Domain�Index)�BuildEnvironment)�EnvironmentCollector)�ApplicationError�ConfigError�VersionRequirementError)�EventManager)�	Extension)�
lexer_classes)�__)�Project)�SphinxComponentRegistry)�XRefRole)�Theme)�docutils�logging�progress_message)�
BuildPhase)�bold)�CatalogRepository)�prefixed_warnings)�abspath�	ensuredir�relpath)�Tags)�RoleFunction�TitleGetter)�Node)�Builder)0zsphinx.addnodeszsphinx.builders.changeszsphinx.builders.epub3zsphinx.builders.dirhtmlzsphinx.builders.dummyzsphinx.builders.gettextzsphinx.builders.htmlzsphinx.builders.latexzsphinx.builders.linkcheckzsphinx.builders.manpagezsphinx.builders.singlehtmlzsphinx.builders.texinfozsphinx.builders.textzsphinx.builders.xmlz
sphinx.configzsphinx.domains.czsphinx.domains.changesetzsphinx.domains.citationzsphinx.domains.cppzsphinx.domains.indexzsphinx.domains.javascriptzsphinx.domains.mathzsphinx.domains.pythonzsphinx.domains.rstzsphinx.domains.stdzsphinx.directiveszsphinx.directives.codezsphinx.directives.otherzsphinx.directives.patcheszsphinx.extensionzsphinx.parserszsphinx.registryzsphinx.roleszsphinx.transformsz%sphinx.transforms.compact_bullet_listzsphinx.transforms.i18nzsphinx.transforms.referencesz!sphinx.transforms.post_transformsz&sphinx.transforms.post_transforms.codez(sphinx.transforms.post_transforms.imageszsphinx.util.compatzsphinx.versioningz*sphinx.environment.collectors.dependenciesz#sphinx.environment.collectors.assetz&sphinx.environment.collectors.metadataz#sphinx.environment.collectors.titlez%sphinx.environment.collectors.toctree�	alabasterzenvironment.picklec@s�eZdZUdZeed<eed<dejej	ddddddf	de
dee
d	e
d
e
de
ded
e
de
dededee
dedededdfdd�Zd�dd�Zdeddfdd�Zde
ddfdd�Zde
ddfdd �Zd�d!d"�Zd�d#ed$ee
ddfd%d&�Zd'e
ddfd(d)�Zd*e
ddfd+d,�Zd�d.e
d/ed0edefd1d2�Zd3eddfd4d5�Zd6d7�d.e
d8ed9eeed:fdefd;d<�Zd6d7�d.e
d8ed9eeed:fdefd=d>�Z d�d?edd@eddfdAdB�Z!	6d�de
dCedDe"ee
fdEeddf
dFdG�Z#de
ddfdHdI�Z$	d�de
dJee%j&d@eddfdKdL�Z'd�dMee(d@edNeeeefddfdOdP�Z)	d�dMee(dQe
dRe*d@edNeeefddfdSdT�Z+d�de
dUee,d@eddfdVdW�Z-d�de
dXed@eddfdYdZ�Z.d�de
d[ed@eddfd\d]�Z/d�d^ee0d@eddfd_d`�Z1	d�d^e
de
dUee,d@eddf
dadb�Z2	d�d^e
de
dXe"e3e4fd@eddf
dcdd�Z5d�d^e
deee6d@eddfdfdg�Z7dhdddhgdfdie
dje
dke
dledmee8dne
doed@eddfdpdq�Z9	h	h	d�die
dje
dke
dmee8dne
d@eddfdrds�Z:dtee;ddfdudv�Z<dtee;ddfdwdx�Z=d�dye
d0edNeddfdzd{�Z>d�dye
d0edNeddfd|d}�Z?d�dye
d~ede
ddfd�d��Z@		d�d�e
d�e
d�eddfd�d��ZAd�e
d�eeBddfd�d��ZCd�dUed@eddfd�d��ZDd�ed�eee
egefddfd�d��ZEdUeddfd�d��ZFd�d�e
d�e
d@eddfd�d��ZGd�d�eeHd@eddfd�d��ZId�eeJddfd�d��ZKde
d�e
ddfd�d��ZL		d�de
d�eeefd�eeefddfd�d��ZMd�e
d�e
ddfd�d��ZNd�e
defd�d��ZOd�d��ZPeQdee
e
ffd�d���ZRdS)��SphinxaThe main application class and extensibility interface.

    :ivar srcdir: Directory containing source.
    :ivar confdir: Directory containing ``conf.py``.
    :ivar doctreedir: Directory for storing pickled doctrees.
    :ivar outdir: Directory for storing build documents.
    �warningiserror�
_warncountNFr�srcdir�confdir�outdir�
doctreedir�buildername�
confoverrides�status�warning�freshenv�tags�	verbosity�parallel�
keep_going�returncCsHtj|_||_i|_d|_d|_d|_t�|_	t
|�|_t
|�|_t
|�|_
t�|j�s5ttd�|j��t�|j�rJt�|j�sJttd�|j��|j|jkrVttd���|
|_|duret�|_d|_n||_d|_|durtt�|_n||_d|_|
o}||_|jr�d|_n|
|_t�||j|j�t|�|_tdd�|_ t!�"t#td	�t$j%��t&j'd
kr�t(�)�dkr�|
dkr�t!�"t#td
���d|_*t+|�|_,|dur�|j|_-t.i|p�i�|_/nt
|�|_-t.�0|j-|p�i|j,�|_/|j/�1�|�2�|j/j3�r|j/j3t$j%k�rt4td�|j/j3��t5D]}|�6|��q
|j/jD]}|�6|��q|�7|�t�|��sIt8td���t9|�Wd�n	1�sDwY|j/j�r}td�d}t:|��t;|j/j��rg|j/�|�nt<td���Wd�n	1�sxwY|j/�=�|j�>d|j/�t?|j|j/j@�|_|�A|�|_|�B|	�|�C�dS)Nz!Cannot find source directory (%s)z(Output directory (%s) is not a directoryz>Source directory and destination directory cannot be identicalTFr�
)�maxlenzRunning Sphinx v%s)���Darwin�z�For security reasons, parallel mode is disabled on macOS and python3.8 and above. For more details, please read https://github.com/sphinx-doc/sphinx/issues/6803zWThis project needs at least Sphinx v%s and therefore cannot be built with this version.zmaking output directoryzwhile setting up extension %s:zconf.pyz�'setup' as currently defined in conf.py isn't a Python callable. Please modify its definition to make it a callable function. This is needed for conf.py to behave as a Sphinx extension.z
config-inited)Dr-�INITIALIZATION�phaserG�
extensions�builder�env�projectr'�registryr1r=r?r@r�isdirrr%�existsrHr�_status�quiet�_warningr<rIr;r+�setupr"�eventsr�
messagelog�logger�infor.�sphinx�__display_version__�sys�version_info�platform�system�
statuscoder4rFr>r�config�read�pre_init_values�
_init_i18n�needs_sphinxr!�builtin_extensions�setup_extension�preload_builderr,r2r0�callabler �init_values�emitr&�
source_suffix�create_builder�	_init_env�
_init_builder)�selfr=r>r?r@rArBrCrDrEr;rFrGrHrI�	extension�prefix�r{�4/usr/lib/python3/dist-packages/sphinx/application.py�__init__�s�


��





��

�

���

zSphinx.__init__cCs�|jjdurt�gd�\|_}dStjttd�|jj�dd�t	|j
|jj|jj|jj�}|j
D]}|jdkrF|��rF|�|jj|jj�q1t|j�}|dg7}|t�td�g7}t�||jj�\|_}|sm|jjdkrvt�td��dSt�td	��dS)
zhLoad translated strings from the configured localedirs if enabled in
        the configuration.
        Nzloading translations [%s]... T)�nonlrbr�en�donez#not available for built-in messages)ri�languager�init�
translatorr`rar.r%r/r=�locale_dirs�source_encoding�catalogs�domain�is_outdated�write_mo� gettext_allow_fuzzy_translations�listr�joinr)rx�has_translation�repo�catalogr�r{r{r|rl
s*��

��

zSphinx._init_i18nc
Cst�|jt�}|stj�|�st|�|_|j�|j	|j
�dSzEttd���4t
|d��}t�|�|_|j�|�Wd�n1sCwYWd�WdSWd�WdS1s]wYWdSty�}zt�td�|�|jdd�WYd}~dSd}~ww)Nzloading pickled environment�rbz
failed: %sT)rE)rr�r@�ENV_PICKLE_FILENAME�osrYrrU�
find_filesrirTr,r%�open�pickle�loadr]�	Exceptionr`rarv)rxrE�filename�f�errr{r{r|rv's$
��&���zSphinx._init_env�namecCs|j�||�dS)N)rWrp�rxr�r{r{r|rp6szSphinx.preload_builderr8cCs(|dur
t�td��d}|j�||�S)Nz(No builder selected, using default: html�html)r`rar%rWrur�r{r{r|ru9szSphinx.create_buildercCs(|j�|j�|j��|j�d�dS)Nzbuilder-inited)rT�set_environmentrUr�r^rs�rxr{r{r|rw@s
zSphinx._init_builder�	force_all�	filenamesc
Cs�tj|_z�|r|j��|j��n|r!|j�|�|j�|�n
|j��|j�	�|j
r4|jr4d|_|jdkr=t
d�nt
d�}|j
rq|jrV|j
dkrQt
d�}nt
d�}n|j
dkr`t
d�}nt
d�}t�t|||j
f��nt�tt
d	�|��|jdkr�|jjr�t�d
�t�|jjt|j�|jjd��Wn%ty�}zt�|jt�}t�|�r�t�|�|j� d|��d}~ww|j� dd�|j�!�dS)
NrPr�	succeededzfinished with problemsz7build %s, %s warning (with warnings treated as errors).z8build %s, %s warnings (with warnings treated as errors).zbuild %s, %s warning.zbuild %s, %s warnings.z	build %s.�)r?rVzbuild-finished)"r-�READINGrRrT�compile_all_catalogs�	build_all�compile_specific_catalogs�build_specific�compile_update_catalogs�build_updater<rIrhr%r;r`rar.�epilogr3r?rirVr�rr�r@r��isfiler��unlinkr^rs�cleanup)rxr�r�rC�msgr��envfiler{r{r|�buildGsT


�







��

��zSphinx.build�extnamecCst�d|�|j�||�dS)z�Import and setup a Sphinx extension module.

        Load the extension given by the module *name*.  Use this if your
        extension needs the features provided by another extension.  No-op if
        called twice.
        z[app] setting up extension: %rN)r`�debugrW�load_extension)rxr�r{r{r|ro|szSphinx.setup_extension�versioncCs|tjdd�kr
t|��dS)aCheck the Sphinx version if requested.

        Compare *version* with the version of the running Sphinx, and abort the
        build when it is too old.

        :param version: The required version in the form of ``major.minor``.

        .. versionadded:: 1.0
        NrM)rbrcr!)rxr�r{r{r|�require_sphinx�s
�zSphinx.require_sphinx���event�callback�prioritycCs&|j�|||�}t�d||||�|S)a?Register *callback* to be called when *event* is emitted.

        For details on available core events and the arguments of callback
        functions, please see :ref:`events`.

        :param event: The name of target event
        :param callback: Callback function for the event
        :param priority: The priority of the callback.  The callbacks will be invoked
                         in order of *priority* (ascending).
        :return: A listener ID.  It can be used for :meth:`disconnect`.

        .. versionchanged:: 3.0

           Support *priority*
        z*[app] connecting event %r (%d): %r [id=%s])r^�connectr`r�)rxr�r�r��listener_idr{r{r|r��s
�zSphinx.connectr�cC�t�d|�|j�|�dS)zvUnregister callback by *listener_id*.

        :param listener_id: A listener_id that :meth:`connect` returns
        z"[app] disconnecting event: [id=%s]N)r`r�r^�
disconnect)rxr�r{r{r|r��szSphinx.disconnectr{)�allowed_exceptions�argsr�.cG�|jj|g|�Rd|i�S)a�Emit *event* and pass *arguments* to the callback functions.

        Return the return values of all callbacks as a list.  Do not emit core
        Sphinx events in extensions!

        :param event: The name of event that will be emitted
        :param args: The arguments for the event
        :param allowed_exceptions: The list of exceptions that are allowed in the callbacks

        .. versionchanged:: 3.1

           Added *allowed_exceptions* to specify path-through exceptions
        r�)r^rs�rxr�r�r�r{r{r|rs�szSphinx.emitcGr�)a�Emit *event* and pass *arguments* to the callback functions.

        Return the result of the first callback that doesn't return ``None``.

        :param event: The name of event that will be emitted
        :param args: The arguments for the event
        :param allowed_exceptions: The list of exceptions that are allowed in the callbacks

        .. versionadded:: 0.5
        .. versionchanged:: 3.1

           Added *allowed_exceptions* to specify path-through exceptions
        r�)r^�emit_firstresultr�r{r{r|r��s�zSphinx.emit_firstresultrT�overridecC�|jj||d�dS)a#Register a new builder.

        :param builder: A builder class
        :param override: If true, install the builder forcedly even if another builder
                         is already installed as the same name

        .. versionchanged:: 1.8
           Add *override* keyword.
        �r�N)rW�add_builder)rxrTr�r{r{r|r��s
zSphinx.add_builder�default�rebuild�typescCs>t�d||||f�|dvr|rdnd}|j�||||�dS)agRegister a configuration value.

        This is necessary for Sphinx to recognize new values and set default
        values accordingly.


        :param name: The name of the configuration value.  It is recommended to be prefixed
                     with the extension name (ex. ``html_logo``, ``epub_title``)
        :param default: The default value of the configuration.
        :param rebuild: The condition of rebuild.  It must be one of those values:

                        * ``'env'`` if a change in the setting only takes effect when a
                          document is parsed -- this means that the whole environment must be
                          rebuilt.
                        * ``'html'`` if a change in the setting needs a full rebuild of HTML
                          documents.
                        * ``''`` if a change in the setting will not need any special rebuild.
        :param types: The type of configuration value.  A list of types can be specified.  For
                      example, ``[str]`` is used to describe a configuration that takes string
                      value.

        .. versionchanged:: 0.4
           If the *default* value is a callable, it will be called with the
           config object as its argument in order to get the default value.
           This can be used to implement config values whose default depends on
           other values.

        .. versionchanged:: 0.6
           Changed *rebuild* from a simple boolean (equivalent to ``''`` or
           ``'env'``) to a string.  However, booleans are still accepted and
           converted internally.
        z[app] adding config value: %r)FTrUr�N)r`r�ri�add)rxr�r�r�r�r{r{r|�add_config_value�s"zSphinx.add_config_valuecCr�)z�Register an event called *name*.

        This is needed to be able to emit it.

        :param name: The name of the event
        z[app] adding event: %rN)r`r�r^r�r�r{r{r|�	add_event
�zSphinx.add_event�translator_classcC�|jj|||d�dS)a�Register or override a Docutils translator class.

        This is used to register a custom output translator or to replace a
        builtin translator.  This allows extensions to use a custom translator
        and define custom nodes for the translator (see :meth:`add_node`).

        :param name: The name of the builder for the translator
        :param translator_class: A translator class
        :param override: If true, install the translator forcedly even if another translator
                         is already installed as the same name

        .. versionadded:: 1.3
        .. versionchanged:: 1.8
           Add *override* keyword.
        r�N)rW�add_translator)rxr�r�r�r{r{r|�set_translatorszSphinx.set_translator�node�kwargscKsXt�d||f�|st�|�rtjtd�|jddd�t�|�|jj	|fi|��dS)a�Register a Docutils node class.

        This is necessary for Docutils internals.  It may also be used in the
        future to validate nodes in the parsed documents.

        :param node: A node class
        :param kwargs: Visitor functions for each builder (see below)
        :param override: If true, install the node forcedly even if another node is already
                         installed as the same name

        Node visitor functions for the Sphinx HTML, LaTeX, text and manpage
        writers can be given as keyword arguments: the keyword should be one or
        more of ``'html'``, ``'latex'``, ``'text'``, ``'man'``, ``'texinfo'``
        or any other supported translators, the value a 2-tuple of ``(visit,
        depart)`` methods.  ``depart`` can be ``None`` if the ``visit``
        function raises :exc:`docutils.nodes.SkipNode`.  Example:

        .. code-block:: python

           class math(docutils.nodes.Element): pass

           def visit_math_html(self, node):
               self.body.append(self.starttag(node, 'math'))
           def depart_math_html(self, node):
               self.body.append('</math>')

           app.add_node(math, html=(visit_math_html, depart_math_html))

        Obviously, translators for which you don't specify visitor methods will
        choke on the node when encountered in a document to translate.

        .. versionchanged:: 0.5
           Added the support for keyword arguments giving visit functions.
        z[app] adding node: %rzDnode class %r is already registered, its visitors will be overridden�app�add_node��type�subtypeN)
r`r�r*�is_node_registeredrDr%�__name__�
register_noderW�add_translation_handlers)rxr�r�r�r{r{r|r�'s$
�
zSphinx.add_node�figtype�title_gettercKs.|jj||||d�|j|fd|i|��dS)a_Register a Docutils node class as a numfig target.

        Sphinx numbers the node automatically. And then the users can refer it
        using :rst:role:`numref`.

        :param node: A node class
        :param figtype: The type of enumerable nodes.  Each figtype has individual numbering
                        sequences.  As system figtypes, ``figure``, ``table`` and
                        ``code-block`` are defined.  It is possible to add custom nodes to
                        these default figtypes.  It is also possible to define new custom
                        figtype if a new figtype is given.
        :param title_getter: A getter function to obtain the title of node.  It takes an
                             instance of the enumerable node, and it must return its title as
                             string.  The title is used to the default title of references for
                             :rst:role:`ref`.  By default, Sphinx searches
                             ``docutils.nodes.caption`` or ``docutils.nodes.title`` from the
                             node as a title.
        :param kwargs: Visitor functions for each builder (same as :meth:`add_node`)
        :param override: If true, install the node forcedly even if another node is already
                         installed as the same name

        .. versionadded:: 1.4
        r�r�N)rW�add_enumerable_noder�)rxr�r�r�r�r�r{r{r|r�SszSphinx.add_enumerable_node�clscC�Dt�d||f�|st�|�rtjtd�|ddd�t�||�dS)a^Register a Docutils directive.

        :param name: The name of the directive
        :param cls: A directive class
        :param override: If true, install the directive forcedly even if another directive
                         is already installed as the same name

        For example, a custom directive named ``my-directive`` would be added
        like this:

        .. code-block:: python

           from docutils.parsers.rst import Directive, directives

           class MyDirective(Directive):
               has_content = True
               required_arguments = 1
               optional_arguments = 0
               final_argument_whitespace = True
               option_spec = {
                   'class': directives.class_option,
                   'name': directives.unchanged,
               }

               def run(self):
                   ...

           def setup(app):
               app.add_directive('my-directive', MyDirective)

        For more details, see `the Docutils docs
        <https://docutils.sourceforge.io/docs/howto/rst-directives.html>`__ .

        .. versionchanged:: 0.6
           Docutils 0.5-style directive classes are now supported.
        .. deprecated:: 1.8
           Docutils 0.4-style (function based) directives support is deprecated.
        .. versionchanged:: 1.8
           Add *override* keyword.
        z[app] adding directive: %rz9directive %r is already registered, it will be overriddenr��
add_directiver�N)r`r�r*�is_directive_registeredrDr%�register_directive)rxr�r�r�r{r{r|r�ps)
�zSphinx.add_directive�rolecCr�)a�Register a Docutils role.

        :param name: The name of role
        :param role: A role function
        :param override: If true, install the role forcedly even if another role is already
                         installed as the same name

        For more details about role functions, see `the Docutils docs
        <https://docutils.sourceforge.io/docs/howto/rst-roles.html>`__ .

        .. versionchanged:: 1.8
           Add *override* keyword.
        z[app] adding role: %r�4role %r is already registered, it will be overriddenr��add_roler�N)r`r�r*�is_role_registeredrDr%�
register_role)rxr�r�r�r{r{r|r��s
�zSphinx.add_role�	nodeclasscCsPt�d||f�|st�|�rtjtd�|ddd�t�||�}t�||�dS)a�Register a generic Docutils role.

        Register a Docutils role that does nothing but wrap its contents in the
        node given by *nodeclass*.

        If *override* is True, the given *nodeclass* is forcedly installed even if
        a role named as *name* is already installed.

        .. versionadded:: 0.6
        .. versionchanged:: 1.8
           Add *override* keyword.
        z[app] adding generic role: %rr�r��add_generic_roler�N)	r`r�r*r�rDr%r�GenericRoler�)rxr�r�r�r�r{r{r|r��s
�zSphinx.add_generic_roler�cCr�)a8Register a domain.

        :param domain: A domain class
        :param override: If true, install the domain forcedly even if another domain
                         is already installed as the same name

        .. versionadded:: 1.0
        .. versionchanged:: 1.8
           Add *override* keyword.
        r�N)rW�
add_domain)rxr�r�r{r{r|r��szSphinx.add_domaincC�|jj||||d�dS)aRegister a Docutils directive in a domain.

        Like :meth:`add_directive`, but the directive is added to the domain
        named *domain*.

        :param domain: The name of target domain
        :param name: A name of directive
        :param cls: A directive class
        :param override: If true, install the directive forcedly even if another directive
                         is already installed as the same name

        .. versionadded:: 1.0
        .. versionchanged:: 1.8
           Add *override* keyword.
        r�N)rW�add_directive_to_domain)rxr�r�r�r�r{r{r|r���zSphinx.add_directive_to_domaincCr�)aRegister a Docutils role in a domain.

        Like :meth:`add_role`, but the role is added to the domain named
        *domain*.

        :param domain: The name of the target domain
        :param name: The name of the role
        :param role: The role function
        :param override: If true, install the role forcedly even if another role is already
                         installed as the same name

        .. versionadded:: 1.0
        .. versionchanged:: 1.8
           Add *override* keyword.
        r�N)rW�add_role_to_domain)rxr�r�r�r�r{r{r|r��r�zSphinx.add_role_to_domain�indexcCs|j�||�dS)a�Register a custom index for a domain.

        Add a custom *index* class to the domain named *domain*.

        :param domain: The name of the target domain
        :param index: The index class
        :param override: If true, install the index forcedly even if another index is
                         already installed as the same name

        .. versionadded:: 1.0
        .. versionchanged:: 1.8
           Add *override* keyword.
        N)rW�add_index_to_domain)rxr�r�r�r{r{r|r��szSphinx.add_index_to_domainr��
directivename�rolename�
indextemplate�
parse_node�
ref_nodeclass�objname�doc_field_typesc		
Cs |jj||||||||d�dS)aX
Register a new object type.

        This method is a very convenient way to add a new :term:`object` type
        that can be cross-referenced.  It will do this:

        - Create a new directive (called *directivename*) for documenting an
          object.  It will automatically add index entries if *indextemplate*
          is nonempty; if given, it must contain exactly one instance of
          ``%s``.  See the example below for how the template will be
          interpreted.
        - Create a new role (called *rolename*) to cross-reference to these
          object descriptions.
        - If you provide *parse_node*, it must be a function that takes a
          string and a docutils node, and it must populate the node with
          children parsed from the string.  It must then return the name of the
          item to be used in cross-referencing and index entries.  See the
          :file:`conf.py` file in the source for this documentation for an
          example.
        - The *objname* (if not given, will default to *directivename*) names
          the type of object.  It is used when listing objects, e.g. in search
          results.

        For example, if you have this call in a custom Sphinx extension::

           app.add_object_type('directive', 'dir', 'pair: %s; directive')

        you can use this markup in your documents::

           .. rst:directive:: function

              Document a function.

           <...>

           See also the :rst:dir:`function` directive.

        For the directive, an index entry will be generated as if you had prepended ::

           .. index:: pair: function; directive

        The reference node will be of class ``literal`` (so it will be rendered
        in a proportional font, as appropriate for code) unless you give the
        *ref_nodeclass* argument, which must be a docutils node class.  Most
        useful are ``docutils.nodes.emphasis`` or ``docutils.nodes.strong`` --
        you can also use ``docutils.nodes.generated`` if you want no further
        text decoration.  If the text should be treated as literal (e.g. no
        smart quote replacement), but not have typewriter styling, use
        ``sphinx.addnodes.literal_emphasis`` or
        ``sphinx.addnodes.literal_strong``.

        For the role content, you have the same syntactical possibilities as
        for standard Sphinx roles (see :ref:`xref-syntax`).

        If *override* is True, the given object_type is forcedly installed even if
        an object_type having the same name is already installed.

        .. versionchanged:: 1.8
           Add *override* keyword.
        r�N)rW�add_object_type)	rxr�r�r�r�r�r�r�r�r{r{r|r�s?
�zSphinx.add_object_typecCs|jj||||||d�dS)aRegister a new crossref object type.

        This method is very similar to :meth:`add_object_type` except that the
        directive it generates must be empty, and will produce no output.

        That means that you can add semantic targets to your sources, and refer
        to them using custom roles instead of generic ones (like
        :rst:role:`ref`).  Example call::

           app.add_crossref_type('topic', 'topic', 'single: %s',
                                 docutils.nodes.emphasis)

        Example usage::

           .. topic:: application API

           The application API
           -------------------

           Some random text here.

           See also :topic:`this section <application API>`.

        (Of course, the element following the ``topic`` directive needn't be a
        section.)

        If *override* is True, the given crossref_type is forcedly installed even if
        a crossref_type having the same name is already installed.

        .. versionchanged:: 1.8
           Add *override* keyword.
        r�N)rW�add_crossref_type)rxr�r�r�r�r�r�r{r{r|r�Qs
#
�zSphinx.add_crossref_type�	transformcC�|j�|�dS)a=Register a Docutils transform to be applied after parsing.

        Add the standard docutils :class:`Transform` subclass *transform* to
        the list of transforms that are applied after Sphinx parses a reST
        document.

        :param transform: A transform class

        .. list-table:: priority range categories for Sphinx transforms
           :widths: 20,80

           * - Priority
             - Main purpose in Sphinx
           * - 0-99
             - Fix invalid nodes by docutils. Translate a doctree.
           * - 100-299
             - Preparation
           * - 300-399
             - early
           * - 400-699
             - main
           * - 700-799
             - Post processing. Deadline to modify text and referencing.
           * - 800-899
             - Collect referencing and referenced nodes. Domain processing.
           * - 900-999
             - Finalize and clean up.

        refs: `Transform Priority Range Categories`__

        __ https://docutils.sourceforge.io/docs/ref/transforms.html#transform-priority-range-categories
        N)rW�
add_transform�rxr�r{r{r|rxs!zSphinx.add_transformcCr�)aRegister a Docutils transform to be applied before writing.

        Add the standard docutils :class:`Transform` subclass *transform* to
        the list of transforms that are applied before Sphinx writes a
        document.

        :param transform: A transform class
        N)rW�add_post_transformrr{r{r|r�s	zSphinx.add_post_transformr�cKsD|jj|fd|i|��t|jd�r |jj|fd|i|��dSdS)a>Register a JavaScript file to include in the HTML output.

        Add *filename* to the list of JavaScript files that the default HTML
        template will include in order of *priority* (ascending).  The filename
        must be relative to the HTML static path , or a full URI with scheme.
        If the priority of the JavaScript file is the same as others, the JavaScript
        files will be included in order of registration.  If the keyword
        argument ``body`` is given, its value will be added between the
        ``<script>`` tags. Extra keyword arguments are included as attributes of
        the ``<script>`` tag.

        Example::

            app.add_js_file('example.js')
            # => <script src="_static/example.js"></script>

            app.add_js_file('example.js', async="async")
            # => <script src="_static/example.js" async="async"></script>

            app.add_js_file(None, body="var myVariable = 'foo';")
            # => <script>var myVariable = 'foo';</script>

        .. list-table:: priority range for JavaScript files
           :widths: 20,80

           * - Priority
             - Main purpose in Sphinx
           * - 200
             - default priority for built-in JavaScript files
           * - 500
             - default priority for extensions
           * - 800
             - default priority for :confval:`html_js_files`

        A JavaScript file can be added to the specific HTML page when an extension
        calls this method on :event:`html-page-context` event.

        .. versionadded:: 0.5

        .. versionchanged:: 1.8
           Renamed from ``app.add_javascript()``.
           And it allows keyword arguments as attributes of script tag.

        .. versionchanged:: 3.5
           Take priority argument.  Allow to add a JavaScript file to the specific page.
        r��add_js_fileN)rWr�hasattrrT�rxr�r�r�r{r{r|r�s/�zSphinx.add_js_filecKsPt�d|�|jj|fd|i|��t|jd�r&|jj|fd|i|��dSdS)a�Register a stylesheet to include in the HTML output.

        Add *filename* to the list of CSS files that the default HTML template
        will include in order of *priority* (ascending).  The filename must be
        relative to the HTML static path, or a full URI with scheme.  If the
        priority of the CSS file is the same as others, the CSS files will be
        included in order of registration.  The keyword arguments are also
        accepted for attributes of ``<link>`` tag.

        Example::

            app.add_css_file('custom.css')
            # => <link rel="stylesheet" href="_static/custom.css" type="text/css" />

            app.add_css_file('print.css', media='print')
            # => <link rel="stylesheet" href="_static/print.css"
            #          type="text/css" media="print" />

            app.add_css_file('fancy.css', rel='alternate stylesheet', title='fancy')
            # => <link rel="alternate stylesheet" href="_static/fancy.css"
            #          type="text/css" title="fancy" />

        .. list-table:: priority range for CSS files
           :widths: 20,80

           * - Priority
             - Main purpose in Sphinx
           * - 200
             - default priority for built-in CSS files
           * - 500
             - default priority for extensions
           * - 800
             - default priority for :confval:`html_css_files`

        A CSS file can be added to the specific HTML page when an extension calls
        this method on :event:`html-page-context` event.

        .. versionadded:: 1.0

        .. versionchanged:: 1.6
           Optional ``alternate`` and/or ``title`` attributes can be supplied
           with the arguments *alternate* (a Boolean) and *title* (a string).
           The default is no title and *alternate* = ``False``. For
           more information, refer to the `documentation
           <https://mdn.io/Web/CSS/Alternative_style_sheets>`__.

        .. versionchanged:: 1.8
           Renamed from ``app.add_stylesheet()``.
           And it allows keyword arguments as attributes of link tag.

        .. versionchanged:: 3.5
           Take priority argument.  Allow to add a CSS file to the specific page.
        zpp] adding stylesheet: %rr��add_css_fileN)r`r�rW�
add_css_filesrrTrrr{r{r|r�s
6�zSphinx.add_css_file�	alternate�titlecCsFt�d�i}|rd|d<nd|d<|r||d<|j|fi|��dS)zGAn alias of :meth:`add_css_file`.

        .. deprecated:: 1.8
        zNThe app.add_stylesheet() is deprecated. Please use app.add_css_file() instead.zalternate stylesheet�rel�
stylesheetr	N)r`rDr)rxr�rr	�
attributesr{r{r|�add_stylesheets

zSphinx.add_stylesheet�packagename�options�after_hyperrefcC�|j�|||�dS)a�Register a package to include in the LaTeX source code.

        Add *packagename* to the list of packages that LaTeX source code will
        include.  If you provide *options*, it will be taken to the `\usepackage`
        declaration.  If you set *after_hyperref* truthy, the package will be
        loaded after ``hyperref`` package.

        .. code-block:: python

           app.add_latex_package('mypackage')
           # => \usepackage{mypackage}
           app.add_latex_package('mypackage', 'foo,bar')
           # => \usepackage[foo,bar]{mypackage}

        .. versionadded:: 1.3
        .. versionadded:: 3.1

           *after_hyperref* option.
        N)rW�add_latex_package)rxrrrr{r{r|r(szSphinx.add_latex_package�alias�lexercCst�d||f�|t|<dS)a2Register a new lexer for source code.

        Use *lexer* to highlight code blocks with the given language *alias*.

        .. versionadded:: 0.6
        .. versionchanged:: 2.1
           Take a lexer class as an argument.  An instance of lexers are
           still supported until Sphinx-3.x.
        z[app] adding lexer: %rN)r`r�r$)rxrrr{r{r|�	add_lexer?s
zSphinx.add_lexercCsBt�d|�ddlm}|j�|j|�|jd|j||d�dS)a�Register a new documenter class for the autodoc extension.

        Add *cls* as a new documenter class for the :mod:`sphinx.ext.autodoc`
        extension.  It must be a subclass of
        :class:`sphinx.ext.autodoc.Documenter`.  This allows auto-documenting
        new types of objects.  See the source of the autodoc module for
        examples on how to subclass :class:`Documenter`.

        If *override* is True, the given *cls* is forcedly installed even if
        a documenter having the same name is already installed.

        See :ref:`autodoc_ext_tutorial`.

        .. versionadded:: 0.6
        .. versionchanged:: 2.2
           Add *override* keyword.
        z[app] adding autodocumenter: %rr)�AutodocDirective�autor�N)r`r��sphinx.ext.autodoc.directiverrW�add_documenter�objtyper�)rxr�r�rr{r{r|�add_autodocumenterLszSphinx.add_autodocumenter�typ�gettercCs"t�d||f�|j�||�dS)a�Register a new ``getattr``-like function for the autodoc extension.

        Add *getter*, which must be a function with an interface compatible to
        the :func:`getattr` builtin, as the autodoc attribute getter for
        objects that are instances of *typ*.  All cases where autodoc needs to
        get an attribute of a type are then handled by this function instead of
        :func:`getattr`.

        .. versionadded:: 0.6
        z#[app] adding autodoc attrgetter: %rN)r`r�rW�add_autodoc_attrgetter)rxrrr{r{r|rcszSphinx.add_autodoc_attrgettercCs8t�d|�ddlm}m}t||�sJ�|||j<dS)a�Register a new language for the HTML search index.

        Add *cls*, which must be a subclass of
        :class:`sphinx.search.SearchLanguage`, as a support language for
        building the HTML full-text search index.  The class must have a *lang*
        attribute that indicates the language it should be used for.  See
        :confval:`html_search_language`.

        .. versionadded:: 1.1
        z [app] adding search language: %rr)�SearchLanguage�	languagesN)r`r��
sphinx.searchrr �
issubclass�lang)rxr�rr r{r{r|�add_search_languagerszSphinx.add_search_language�suffix�filetypecCr�)a3Register a suffix of source files.

        Same as :confval:`source_suffix`.  The users can override this
        using the config setting.

        If *override* is True, the given *suffix* is forcedly installed even if
        the same suffix is already installed.

        .. versionadded:: 1.8
        r�N)rW�add_source_suffix)rxr%r&r�r{r{r|r'�szSphinx.add_source_suffix�parsercCr�)a�Register a parser class.

        If *override* is True, the given *parser* is forcedly installed even if
        a parser for the same suffix is already installed.

        .. versionadded:: 1.4
        .. versionchanged:: 1.8
           *suffix* argument is deprecated.  It only accepts *parser* argument.
           Use :meth:`add_source_suffix` API to register suffix instead.
        .. versionchanged:: 1.8
           Add *override* keyword.
        r�N)rW�add_source_parser)rxr(r�r{r{r|r)�s
zSphinx.add_source_parser�	collectorcCst�d|�|��|�dS)zxRegister an environment collector class.

        Refer to :ref:`collector-api`.

        .. versionadded:: 1.6
        z&[app] adding environment collector: %rN)r`r��enable)rxr*r{r{r|�add_env_collector�r�zSphinx.add_env_collector�
theme_pathcCs t�d||�|j�||�dS)z�Register a HTML Theme.

        The *name* is a name of theme, and *theme_path* is a full path to the
        theme (refs: :ref:`distribute-your-theme`).

        .. versionadded:: 1.6
        z[app] adding HTML theme: %r, %rN)r`r�rW�add_html_theme)rxr�r-r{r{r|r.�szSphinx.add_html_theme�inline_renderers�block_rendererscCr)a�Register a math renderer for HTML.

        The *name* is a name of math renderer.  Both *inline_renderers* and
        *block_renderers* are used as visitor functions for the HTML writer:
        the former for inline math node (``nodes.math``), the latter for
        block math node (``nodes.math_block``).  Regarding visitor functions,
        see :meth:`add_node` for details.

        .. versionadded:: 1.8

        N)rW�add_html_math_renderer)rxr�r/r0r{r{r|r1�szSphinx.add_html_math_rendererr��
locale_dircCs$t�|g|jj|�t�||�dS)z�Register a message catalog.

        :param catalog: The name of the catalog
        :param locale_dir: The base path of the message catalog

        For more details, see :func:`sphinx.locale.get_translation()`.

        .. versionadded:: 1.8
        N)rr�rir��init_console)rxr�r2r{r{r|�add_message_catalog�s
zSphinx.add_message_catalogcCs�|dkrd}td�}td�}n|dkrd}td�}td�}ntd	|��|j��D]2}t||d
�}|d
urGt�||j�t�td�|�dS|s[t�||j�t�td�|�dSq)d
S)z�Check whether parallel processing is allowed or not.

        :param typ: A type of processing; ``'read'`` or ``'write'``.
        rj�parallel_read_safez�the %s extension does not declare if it is safe for parallel reading, assuming it isn't - please ask the extension author to check and make it explicitz1the %s extension is not safe for parallel reading�write�parallel_write_safez�the %s extension does not declare if it is safe for parallel writing, assuming it isn't - please ask the extension author to check and make it explicitz1the %s extension is not safe for parallel writingz!parallel type %s is not supportedNzdoing serial %sFT)r%�
ValueErrorrS�values�getattrr`rDr�)rxr�attrname�message_not_declared�message_not_safe�ext�allowedr{r{r|�is_parallel_allowed�s*

�zSphinx.is_parallel_allowedcCs |dvr
td|��||j_dS)z�Set the policy to include assets in HTML pages.

        - always: include the assets in all the pages
        - per_page: include the assets only in pages where they are used

        .. versionadded: 4.1
        )�always�per_pagezpolicy %s is not supportedN)r8rW�html_assets_policy)rx�policyr{r{r|�set_html_assets_policy�szSphinx.set_html_assets_policycCst�dt�|jjS)Nzapp.html_themes is deprecated.)�warnings�warnrrW�html_themesr�r{r{r|rHs�zSphinx.html_themes)rJN)FN)r�)F)r{)NF)r�Nr�F�NN)Sr��
__module__�__qualname__�__doc__�bool�__annotations__�intrd�stdout�stderr�strrr	rr
r}rlrvrprurwr�ror�rr�r�rrr
r�rsr�r�rr�r�r�NodeVisitorr�rr�r6r�rr�r�r�rr�r�r5r(r�rr�rr�r�rrrrrr
rrrrrr$r'rr)rr,r.r1r4r@rE�propertyrHr{r{r{r|r:xsT
�����������
�

5
	��
���
���
�'��
��
�-���
�
� 0���
���
�
�������
�C����
�'#3;
���
�

�

�
�
�
�#r:c	@sjeZdZdZddddedeeddfdd	�Zdefd
d�Z	ded
e
ddfdd�Zded
e
defdd�ZdS)�TemplateBridgez�
    This class defines the interface for a "template bridge", that is, a class
    that renders templates given a template name and a context.
    NrTr8�theme�dirsrJcC�td��)abCalled by the builder to initialize the template system.

        *builder* is the builder object; you'll probably want to look at the
        value of ``builder.config.templates_path``.

        *theme* is a :class:`sphinx.theming.Theme` object or None; in the latter
        case, *dirs* can be list of fixed directories to look for templates.
        �!must be implemented in subclasses��NotImplementedError)rxrTrVrWr{r{r|r�
s	zTemplateBridge.initcCsdS)z�Called by the builder to determine if output files are outdated
        because of template changes.  Return the mtime of the newest template
        file that was changed.  The default implementation returns ``0``.
        rr{r�r{r{r|�newest_template_mtimesz$TemplateBridge.newest_template_mtime�template�contextcCrX)zCalled by the builder to render a template given as a filename with
        a specified context (a Python dictionary).
        rYrZ�rxr]r^r{r{r|�render�zTemplateBridge.rendercCrX)z}Called by the builder to render a template given as a string with a
        specified context (a Python dictionary).
        rYrZr_r{r{r|�
render_string%razTemplateBridge.render_stringrI)
r�rJrKrLr)r
rRr��floatr\r	r`rbr{r{r{r|rUs rU)drLr�r�rfrdrF�collectionsr�iorr�typingrrrrr	r
rrr
rr*r�docutils.nodesrr�docutils.parsersr�docutils.parsers.rstrr�docutils.transformsr�pygments.lexerrrbrr�
sphinx.configr�sphinx.deprecationr�sphinx.domainsrr�sphinx.environmentr�sphinx.environment.collectorsr�
sphinx.errorsrr r!�
sphinx.eventsr"�sphinx.extensionr#�sphinx.highlightingr$�
sphinx.localer%�sphinx.projectr&�sphinx.registryr'�sphinx.rolesr(�sphinx.themingr)�sphinx.utilr+r,�sphinx.util.build_phaser-�sphinx.util.consoler.�sphinx.util.i18nr/�sphinx.util.loggingr0�sphinx.util.osutilr1r2r3�sphinx.util.tagsr4�sphinx.util.typingr5r6r7�sphinx.buildersr8rnr��	getLoggerr�r`r:rUr{r{r{r|�<module>sr06

@ Telegram