-Pho:UdZddlmZddlZddlZddlZddlmZddlm Z ddl m Z m Z ddl mZddlZddlmZmZdd lmZdd lmZdd lmZdd lmZmZmZdd lmZddlmZddl m!Z!ddl"m#Z#ddl$m%Z%ddl&m'Z'm(Z(ddl)m*Z*m+Z+ddl,m-Z-ddl.m/Z/ddl0m1Z1ddl2m3Z3ddl4m5Z5m6Z6ddl7m8Z8e rddl9Z9ddl:m;Z;mZ>m?Z?ddl@mAZAddl mBZBmCZCmDZDmEZEddl'mFZFddlGmHZHmIZIddlJmKZKdd l mLZLdd!lMmNZNdd"lOmPZPdd#lmQZQdd$lRmSZSdd%lmTZTmUZUdd&lVmWZWmXZXdd'lYmZZZdd(l[m\Z\m]Z]dd)l^m_Z_dd*l`maZadd+l$mbZbmcZcmdZdmeZedd,lfmgZgdd-lhmiZidd.ljmkZkdd/llmmZmdd0lnmoZompZpd1Zqd2erd3<d4Zsd5Zteqetz Zqeqesz Zqd6Zue(jvewZxGd7d8ZyGd9d:ZzdS);znSphinx application class and extensibility interface. Gracefully adapted from the TextPress system by Armin. ) annotationsN)deque)StringIO) TYPE_CHECKINGoverload)roles)locale package_dir)bold)Config)BuildEnvironment)ApplicationError ConfigErrorVersionRequirementError) EventManager) lexer_classes)__)Project)SphinxComponentRegistry)docutilslogging)_StrPath_StrPathProperty) BuildPhase)progress_message)CatalogRepository)prefixed_warnings) ensuredirrelpath)Tags)Callable CollectionIterableSequenceSet)Path)IOAnyFinalLiteral)nodes)ElementNode)Parser) Directive) Transform)Lexer)addnodes)Builder)ENUM_ConfigRebuild)DomainIndex)EnvironmentCollector) Documenter _AutodocProcessDocstringListener) todo_node) Extension)_MathsBlockRenderers_MathsInlineRenderers _NodeHandler_NodeHandlerPair)XRefRole)SearchLanguage)Theme)Field) RoleFunction TitleGetter)/zsphinx.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.admonitionszsphinx.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.versioningz*sphinx.environment.collectors.dependenciesz#sphinx.environment.collectors.assetz&sphinx.environment.collectors.metadataz#sphinx.environment.collectors.titlez%sphinx.environment.collectors.toctreeztuple[str, ...]builtin_extensions)zsphinxcontrib.applehelpzsphinxcontrib.devhelpzsphinxcontrib.htmlhelpzsphinxcontrib.serializinghtmlzsphinxcontrib.qthelp) alabasterzenvironment.picklec NeZdZUdZdZded<ded<eZeZeZ eZ de j e j dddd d dddf d d"Zed d$Zdd%Zdd'Zdd(Zeed)dd,Zdd-Zdd/Zdd1Zdd2Zddd6Zdd8Zedd;Ze dddBZ e dddEZ e dddHZ e dddKZ e dddNZ e dddQZ e dddTZ e dd dWZ e dd!dZZ e dd"d]Z e dd#d`Z e dd$dcZ e dd%dfZ e dd&diZ e dd'dlZ e dd(doZ e dd)drZ e dd*duZ e dd+dxZ e dd,d{Z e dd-d~Z e dd.dZ e dd/dZ e dd0dZ e dd1dZ e dd2dZ e dd3dZ e dd4dZ e dd5dZ e dd6dZ dd6dZ d7dZ!ddd8dZ"ddd9dZ#d:d;dZ$ d<d=dZ%ddZ& d:d>dZ' d:d?dZ( d@dAdZ) d:dBdZ*d:dCd„Z+ d:dDdńZ,d:dEdȄZ- d:dFdɄZ. d:dGd˄Z/ d:dHdτZ0 dIdJdڄZ1 dKdLdۄZ2dMdބZ3dMd߄Z4 dNdOdZ5ddPdZ6 d@dQdZ7dRdZ8d:dSdZ9dTdZ:dUdZ; d:dVdZ<d:dWdZ=dXdZ>dYdZ? dZd[dZ@d\dZAd]dZBd^d ZCdS(_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. Fr)warningiserrorint _warncountNrsrcdirstr | os.PathLike[str]confdirstr | os.PathLike[str] | Noneoutdir doctreedir buildernamestr confoverridesdict[str, Any] | NonestatusIO[str] | Nonewarningfreshenvbooltags Sequence[str] verbosityparallel keep_goingpdbexception_on_warningreturnNonec tj|_| |_d|_i|_t |_t| |_ t| |_ t| |_ |j s$ttd|j z|j r=|j s$ttd|j z|j |j krttd| |_|t%|_d|_n||_d|_|t%|_n||_d|_t/| |_t/| |_||_||_t9j||j|jt=||_tAd |_!tD#tItd tJj&d|_'tQ| |_)|$|j |_*tWi|pi|_,nMt| |_*tWj-|j*|pi|j)|_,|.|j,j/rC|j,j/tJj&kr)tatd |j,j/ztbD]}|2||j,jD]}|2||3||j sHtitd 5tk|j dddn #1swxYwY|j,jrtd dz}tm|5to|j,jr|j,|ntqtd dddn #1swxYwY|j,9|j:d|j,tw|j |j,j<|_=|>| |_?|@||_A|B|CdS)aInitialize the Sphinx application. :param srcdir: The path to the source directory. :param confdir: The path to the configuration directory. If not given, it is assumed to be the same as ``srcdir``. :param outdir: Directory for storing build documents. :param doctreedir: Directory for caching pickled doctrees. :param buildername: The name of the builder to use. :param confoverrides: A dictionary of configuration settings that override the settings in the configuration file. :param status: A file-like object to write status messages to. :param warning: A file-like object to write warnings to. :param freshenv: If true, clear the cached environment. :param warningiserror: If true, warnings become errors. :param tags: A list of tags to apply. :param verbosity: The verbosity level. :param parallel: The maximum number of parallel jobs to use when reading/writing documents. :param keep_going: Unused. :param pdb: If true, enable the Python debugger on an exception. :param exception_on_warning: If true, raise an exception on warnings. 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%szWThis 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)DrINITIALIZATIONphaser`_fresh_env_used extensionsrregistryrresolverOrSrTis_dirrrexistsrar_statusquiet_warningrMr]rb_fail_on_warningsrc_exception_on_warningrsetupreventsr messagelogloggerinfor sphinx__display_version__ statuscoder r^rQr configread _init_i18n needs_sphinxrrGsetup_extensionpreload_builderrrrcallabler_report_override_warningsemitr source_suffixproject _init_envenvcreate_builderbuilder_post_init_env _init_builder)selfrOrQrSrTrUrWrYr[r\rKr^r`rarbrcrd extensionprefixs R/var/www/html/test/jupyter/venv/lib/python3.11/site-packages/sphinx/application.py__init__zSphinx.__init__sR . ",002/11 v&&..00 v&&..00 ":..6688{!!## "677$+E  ;      (:(:(<(< "=>>L  ;$+ % %"STT ! >$,JJDL#DJJ!DLDJ ?%-ZZDMM#DM~..!%n!5!5%9" dDL$-888"4(( ',2&6&6&6  D01122F4NOOOJJ ? ;DL ]%8b99DKK#G,,4466DL +dlM4GRSSDK  K $  (6+EEE)2+* + , , ,I   + + + +/ , ,I   + + + + [))){!!## '!"%>"?"?@@ ' '$+&&& ' ' ' ' ' ' ' ' ' ' ' ' ' ' ' ;  899IEF"6**  DK-.. K%%d++++%Z,                --/// $+666t{DK,EFF >>(++**;77   s%=PP"%P"AR44R8;R8 bool | Nonec|jS)zTrue/False as to whether a new environment was created for this build, or None if the environment has not been initialised yet. )rlrs rfresh_env_usedzSphinx.fresh_env_usedNs ##ctttd|jjdt |j|jj|jj|jj }|j D]K}|j dkr>| r*| |jj|jjLt|j}|dgz }|t dz gz }t#j||jj\|_}|s|jjdkr)ttddSttd dS) zhLoad translated strings from the configured localedirs if enabled in the configuration. zloading translations [%s]... T)nonlr|Nr endonez#not available for built-in messages)rzr{r rrlanguagerrO locale_dirssource_encodingcatalogsdomain is_outdatedwrite_mo gettext_allow_fuzzy_translationslistr r init translator)rrepocatalogrhas_translations rrzSphinx._init_i18nUso  344 5 5t{7KRV    ! K K # K K '    }  G~))g.A.A.C.C)  K($+*V.2$2B-C-C v  h.// +1; -, , (  Cdk2d:: KK6 # # # # # KK@AA B B B B Brr c|jtz }|s|s|S||SN)rTENV_PICKLE_FILENAMErq_create_fresh_env_load_existing_env)rr\filenames rrzSphinx._init_envvsN?%88  58??,, 5))++ +**844 4rc2t|}d|_|S)NT)r rl)rrs rrzSphinx._create_fresh_env}st$$# rzloading pickled environmentrr&c` t|d5}tj|}dddn #1swxYwY||d|_nS#t $rF}t td|| }Yd}~nd}~wwxYw|S)NrbFz failed: %s) openpickleloadrwrl Exceptionrzr{rr)rrfrerrs rrzSphinx._load_existing_envs +h%% %k!nn % % % % % % % % % % % % % % % IIdOOO#(D  + + + KK<((# . . .((**CCCCCC + s2A3 A7A7A B+%F/3 3 3$$U$$C)#.. . 4 3reventLiteral['config-inited']callback Callable[[Sphinx, Config], None]prioritycdSrrNrrrrs rconnectzSphinx.connect crLiteral['builder-inited']Callable[[Sphinx], None]cdSrrNrs rrzSphinx.connect rrLiteral['env-get-outdated']QCallable[[Sphinx, BuildEnvironment, Set[str], Set[str], Set[str]], Sequence[str]]cdSrrNrs rrzSphinx.connect crLiteral['env-before-read-docs']5Callable[[Sphinx, BuildEnvironment, list[str]], None]cdSrrNrs rrzSphinx.connectrrLiteral['env-purge-doc']/Callable[[Sphinx, BuildEnvironment, str], None]cdSrrNrs rrzSphinx.connect%rrLiteral['source-read'](Callable[[Sphinx, str, list[str]], None]cdSrrNrs rrzSphinx.connect-rrLiteral['include-read'].Callable[[Sphinx, Path, str, list[str]], None]cdSrrNrs rrzSphinx.connect5rrLiteral['doctree-read'](Callable[[Sphinx, nodes.document], None]cdSrrNrs rrzSphinx.connect=rrLiteral['env-merge-info']FCallable[[Sphinx, BuildEnvironment, Set[str], BuildEnvironment], None]cdSrrNrs rrzSphinx.connectErrLiteral['env-updated'])Callable[[Sphinx, BuildEnvironment], str]cdSrrNrs rrzSphinx.connectOrrLiteral['env-get-updated']3Callable[[Sphinx, BuildEnvironment], Iterable[str]]cdSrrNrs rrzSphinx.connectWrr Literal['env-check-consistency']*Callable[[Sphinx, BuildEnvironment], None]cdSrrNrs rrzSphinx.connect_rrLiteral['write-started']!Callable[[Sphinx, Builder], None]cdSrrNrs rrzSphinx.connectgrrLiteral['doctree-resolved']-Callable[[Sphinx, nodes.document, str], None]cdSrrNrs rrzSphinx.connectorrLiteral['missing-reference']fCallable[[Sphinx, BuildEnvironment, addnodes.pending_xref, nodes.TextElement], nodes.reference | None]cdSrrNrs rrzSphinx.connectw cr!Literal['warn-missing-reference']>Callable[[Sphinx, Domain, addnodes.pending_xref], bool | None]cdSrrNrs rrzSphinx.connectrrLiteral['build-finished']*Callable[[Sphinx, Exception | None], None]cdSrrNrs rrzSphinx.connectrrLiteral['html-collect-pages']=Callable[[Sphinx], Iterable[tuple[str, dict[str, Any], str]]]cdSrrNrs rrzSphinx.connectrrLiteral['html-page-context']HCallable[[Sphinx, str, str, dict[str, Any], nodes.document], str | None]cdSrrNrs rrzSphinx.connectrr Literal['linkcheck-process-uri']#Callable[[Sphinx, str], str | None]cdSrrNrs rrzSphinx.connectrr'Literal['object-description-transform']9Callable[[Sphinx, str, str, addnodes.desc_content], None]cdSrrNrs rrzSphinx.connectrr$Literal['autodoc-process-docstring']r:cdSrrNrs rrzSphinx.connectrr+Literal['autodoc-before-process-signature']#Callable[[Sphinx, Any, bool], None]cdSrrNrs rrzSphinx.connectrr$Literal['autodoc-process-signature']Callable[[Sphinx, Literal['module', 'class', 'exception', 'function', 'method', 'attribute'], str, Any, dict[str, bool], str | None, str | None], tuple[str | None, str | None] | None]cdSrrNrs rrzSphinx.connects &cr Literal['autodoc-process-bases']>Callable[[Sphinx, str, Any, dict[str, bool], list[str]], None]cdSrrNrs rrzSphinx.connectrrLiteral['autodoc-skip-member']Callable[[Sphinx, Literal['module', 'class', 'exception', 'function', 'method', 'attribute'], str, Any, bool, dict[str, bool]], bool]cdSrrNrs rrzSphinx.connects $crLiteral['todo-defined']#Callable[[Sphinx, todo_node], None]cdSrrNrs rrzSphinx.connectrrLiteral['viewcode-find-source']aCallable[[Sphinx, str], tuple[str, dict[str, tuple[Literal['class', 'def', 'other'], int, int]]]]cdSrrNrs rrzSphinx.connectrr#Literal['viewcode-follow-imported'](Callable[[Sphinx, str, str], str | None]cdSrrNrs rrzSphinx.connectrrCallable[..., Any]cdSrrNrs rrzSphinx.connectrrcz|j|||}td|||||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])rxrrzr)rrrr listener_ids rrzSphinx.connect!sJ$k))%8DD  8        rrHcptd||j|dS)zvUnregister callback by *listener_id*. :param listener_id: A listener_id that :meth:`connect` returns z"[app] disconnecting event: [id=%s]N)rzrrx disconnect)rrHs rrJzSphinx.disconnect=s5  9;GGG {+++++r)allowed_exceptionsargsr(rKtuple[type[Exception], ...] list[Any]c.|jj|g|Rd|iS)aEmit *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 rK)rxrrrrKrLs rrz Sphinx.emitEs*& t{TTTTASTTTrc.|jj|g|Rd|iS)aEmit *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 rK)rxemit_firstresultrPs rrRzSphinx.emit_firstresultZs:&,t{+     -?   rr type[Builder]overridec>|j||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. rTN)rn add_builder)rrrTs rrWzSphinx.add_builderss% !!'H!=====rrdefaultrebuildr5typestype | Collection[type] | ENUM descriptionctd||||f|j|||||dS)aRegister 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. :param description: A short description of the configuration 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. .. versionadded:: 7.4 The *description* parameter. z[app] adding config value: %r)rrXrYrZr\N)rzrradd)rrrXrYrZr\s radd_config_valuezSphinx.add_config_valuesYX  4tWgu6UVVV #      rcptd||j|dS)zRegister 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)rzrrxr^rs r add_eventzSphinx.add_events3  -t444 rtranslator_classtype[nodes.NodeVisitor]c@|j|||dS)aRegister 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. rVN)rnadd_translator)rrrbrTs rset_translatorzSphinx.set_translators(* $$T+;h$OOOOOrnode type[Element]kwargsr@c td||f|sDtj|r0tt d|jddtj||jj |fi|dS)aRegister 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): ... def visit_math_html(self, node): self.body.append(self.starttag(node, 'math')) def depart_math_html(self, node): self.body.append('') 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 overriddenappadd_nodetypesubtypeN) rzrris_node_registeredr[r__name__ register_nodernadd_translation_handlers)rrgrTris rrlzSphinx.add_nodesR  ,tVn=== H7==  NN6 "     t$$$. .t>>v>>>>>rfigtype title_getterTitleGetter | None!tuple[_NodeHandler, _NodeHandler]c b|j|||||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 rVrTN)rnadd_enumerable_noderl)rrgrtrurTris rryzSphinx.add_enumerable_node sS> )) '<( *     d88X888888rclstype[Directive]ctd||f|s?tj|r+tt d|ddtj||dS)aRegister a Docutils directive. :param name: The name of the directive :param cls: A directive class :param override: If false, do not install it if another directive is already installed as the same name If true, unconditionally install the directive. 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): pass def setup(app): app.add_directive('my-directive', MyDirective) For more details, see `the Docutils docs `__ . .. 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: %rz=directive %r is already registered and will not be overriddenrk add_directivermN)rzrris_directive_registeredr[rregister_directive)rrrzrTs rr}zSphinx.add_directive0sX  1D#;??? H`__ . .. versionchanged:: 1.8 Add *override* keyword. z[app] adding role: %r8role %r is already registered and will not be overriddenrkadd_rolermN)rzrris_role_registeredr[r register_role)rrrrTs rrzSphinx.add_rolegs  ,tTl;;; H7==  NNMNN"     tT*****r nodeclass type[Node]ctd||f|s?tj|r+tt d|ddt j||}tj||dS)aRegister a generic Docutils role. Register a Docutils role that does nothing but wrap its contents in the node given by *nodeclass*. :param override: If false, do not install it if another role is already installed as the same name If true, unconditionally install the role. .. versionadded:: 0.6 .. versionchanged:: 1.8 Add *override* keyword. z[app] adding generic role: %rrrkadd_generic_rolermN) rzrrrr[rr GenericRoler)rrrrTrs rrzSphinx.add_generic_roles$  4tY6GHHH H7==  NNMNN*      y11tT*****rr type[Domain]c>|j||dS)apRegister a domain. :param domain: A domain class :param override: If false, do not install it if another domain is already installed as the same name If true, unconditionally install the domain. .. versionadded:: 1.0 .. versionchanged:: 1.8 Add *override* keyword. rVN)rn add_domain)rrrTs rrzSphinx.add_domains%   ( ;;;;;rcB|j||||dS)aNRegister 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 false, do not install it if another directive is already installed as the same name If true, unconditionally install the directive. .. versionadded:: 1.0 .. versionchanged:: 1.8 Add *override* keyword. rVN)rnadd_directive_to_domain)rrrrzrTs rrzSphinx.add_directive_to_domains)& --fdC(-SSSSSrRoleFunction | XRefRolecB|j||||dS)a;Register 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 false, do not install it if another role is already installed as the same name If true, unconditionally install the role. .. versionadded:: 1.0 .. versionchanged:: 1.8 Add *override* keyword. rVN)rnadd_role_to_domain)rrrrrTs rrzSphinx.add_role_to_domains). ((th(OOOOOrindex type[Index] _overridec<|j||dS)aRegister 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 false, do not install it if another index is already installed as the same name If true, unconditionally install the index. .. versionadded:: 1.0 .. versionchanged:: 1.8 Add *override* keyword. N)rnadd_index_to_domain)rrrrs rrzSphinx.add_index_to_domains"" ))&%88888r directivenamerolename indextemplate parse_nodeFCallable[[BuildEnvironment, str, addnodes.desc_signature], str] | None ref_nodeclasstype[nodes.TextElement] | Noneobjnamedoc_field_typesSequence[Field]c J|j||||||||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. rVN)rnadd_object_type) rrrrrrrrrTs rrzSphinx.add_object_typesFN %%        & rcF|j||||||dS)arRegister a new crossref object type. This method is very similar to :meth:`~Sphinx.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 `. (Of course, the element following the ``topic`` directive needn't be a section.) :param override: If false, do not install it if another cross-reference type is already installed as the same name If true, unconditionally install the cross-reference type. .. versionchanged:: 1.8 Add *override* keyword. rVN)rnadd_crossref_type)rrrrrrrTs rrzSphinx.add_crossref_type>s@X ''      (     r transformtype[Transform]c:|j|dS)aRRegister a Docutils transform to be applied after parsing. Add the standard docutils :class:`~docutils.transforms.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)rn add_transformrrs rrzSphinx.add_transformss!B ##I.....rc:|j|dS)a-Register a Docutils transform to be applied before writing. Add the standard docutils :class:`~docutils.transforms.Transform` subclass *transform* to the list of transforms that are applied before Sphinx writes a document. :param transform: A transform class N)rnadd_post_transformrs rrzSphinx.add_post_transforms  ((33333r str | Noneloading_methodc |dkrd|d<n |dkrd|d<|pd}|jj|fd|i|tjt5|jj|fd|i|ddddS#1swxYwYdS)a) Register a JavaScript file to include in the HTML output. :param filename: The name of a JavaScript file that the default HTML template will include. It must be relative to the HTML static path, or a full URI with scheme, or ``None`` . The ``None`` value is used to create an inline `` app.add_js_file('example.js', loading_method='async') # => app.add_js_file(None, body="var myVariable = 'foo';") # => .. 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. .. versionchanged:: 4.4 Take loading_method argument. Allow to change the loading method of the JavaScript file. asyncdeferrrN)rn add_js_file contextlibsuppressAttributeErrorr)rrrrris rrzSphinx.add_js_files@ W $ $%F7OO w & &%F7O>r! !(HHXHHHH   0 0   $DL $  #+ /5                      A--A14A1c td||jj|fd|i|t jt 5|jj|fd|i|ddddS#1swxYwYdS)ay Register a stylesheet to include in the HTML output. :param filename: The name of a CSS file that the default HTML template will include. It must be relative to the HTML static path, or a full URI with scheme. :param priority: Files are included in ascending order of priority. If multiple CSS files have the same priority, those files will be included in order of registration. See list of "priority range for CSS files" below. :param kwargs: Extra keyword arguments are included as attributes of the ```` tag. Example:: app.add_css_file('custom.css') # => app.add_css_file('print.css', media='print') # => app.add_css_file('fancy.css', rel='alternate stylesheet', 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 `__. .. 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: %rrN) rzrrn add_css_filesrrrr add_css_file)rrrris rrzSphinx.add_css_filesr  2H===# #HJJxJ6JJJ   0 0   %DL %  #+ /5                     r packagenameoptionsafter_hyperrefc>|j|||dS)aRegister 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)rnadd_latex_package)rrrrs rrzSphinx.add_latex_package-s$, '' WnMMMMMraliaslexer type[Lexer]cTtd||f|t|<dS)aIRegister 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. .. versionchanged:: 4.0 Removed support for lexer instances as an argument. z[app] adding lexer: %rN)rzrr)rrrs r add_lexerzSphinx.add_lexerEs-  -u~>>>$ ertype[Documenter]ctd|ddlm}|j|j||d|jz||dS)aRegister 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:`~sphinx.ext.autodoc.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)AutodocDirectiveautorVN)rzrsphinx.ext.autodoc.directiverrnadd_documenterobjtyper})rrzrTrs radd_autodocumenterzSphinx.add_autodocumenterSsn$  6<<<AAAAAA $$S[#666 6CK/1AHUUUUUrtyprngetterCallable[[Any, str, Any], Any]cvtd||f|j||dS)aRegister 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)rzrrnadd_autodoc_attrgetter)rrrs rrzSphinx.add_autodoc_attrgetterks;  :S&MJJJ ,,S&99999rtype[SearchLanguage]c\td|ddlm}|||j<dS)aRegister 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) languagesN)rzr sphinx.searchrlang)rrzrs radd_search_languagezSphinx.add_search_language{s=  7===++++++! #(rsuffixfiletypec@|j|||dS)aoRegister a suffix of source files. Same as :confval:`source_suffix`. The users can override this using the config setting. :param override: If false, do not install it the same suffix is already installed. If true, unconditionally install the suffix. .. versionadded:: 1.8 rVN)rnadd_source_suffix)rrrrTs rrzSphinx.add_source_suffixs' ''8'LLLLLrparser type[Parser]c>|j||dS)a Register a parser class. :param override: If false, do not install it if another parser is already installed for the same suffix. If true, unconditionally install the parser. .. 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. rVN)rnadd_source_parser)rrrTs rrzSphinx.add_source_parsers% '''BBBBBr collectortype[EnvironmentCollector]cvtd|||dS)zxRegister an environment collector class. Refer to :ref:`collector-api`. .. versionadded:: 1.6 z&[app] adding environment collector: %rN)rzrenable)rrs radd_env_collectorzSphinx.add_env_collectors9  =yIII 4     r theme_pathcttd|||j||dS)zRegister 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)rzrrnadd_html_theme)rrrs rrzSphinx.add_html_themes9  6jIII $$T:66666rinline_renderers_MathsInlineRenderers | Noneblock_renderers_MathsBlockRenderers | Nonec>|j|||dS)aRegister 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)rnadd_html_math_renderer)rrrrs rrzSphinx.add_html_math_renderers%" ,,T3C_UUUUUrr locale_dircrtj|g|jj|tj||dS)zRegister 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)r rrr init_console)rrrs radd_message_catalogzSphinx.add_message_catalogs8  ZL$+"6@@@J00000rcT|dkr!d}td}td}n9|dkr!d}td}td}ntd |z|jD]}t ||d }|Kt ||jt td |d S|sKt ||jt td |d Sd S)zCheck whether parallel processing is allowed or not. :param typ: A type of processing; ``'read'`` or ``'write'``. rparallel_read_safezthe %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 readingwriteparallel_write_safezthe %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 ValueErrorrmvaluesgetattrrzr[r)rrattrnamemessage_not_declaredmessage_not_safeextalloweds ris_parallel_allowedzSphinx.is_parallel_allowedsC &==+H#%0$$ ""UVV   G^^,H#%0$$ ""UVV  @3FGG G?))++  Cc8T22G3SX>>>r"344c:::uu /:::r"344c:::uu  trpolicyLiteral['always', 'per_page']cJ|dvrtd|z||j_dS)zSet 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 >alwaysper_pagezpolicy %s is not supportedN)rrnhtml_assets_policy)rrs rset_html_assets_policyzSphinx.set_html_assets_policy s4 / / /9FBCC C+1 (((r)"rOrPrQrRrSrPrTrPrUrVrWrXrYrZr[rZr\r]rKr]r^r_r`rLrarLrbr]rcr]rdr]rerf)rer)rerf)r\r]rer )rer )rr&rer )rrVrerf)rrVrer3)FrN)rr]rrrerf)rrVrerf)rrrerf)r)rrrrrrLrerL)rrrrrrLrerL)rrrrrrLrerL)rrrrrrLrerL)rrrrrrLrerL)rrrrrrLrerL)rrrrrrLrerL)rrrrrrLrerL)rrrrrrLrerL)rr rr rrLrerL)rr rr rrLrerL)rrrrrrLrerL)rrrrrrLrerL)rrrrrrLrerL)rrrrrrLrerL)rrrrrrLrerL)rrrr rrLrerL)rr"rr#rrLrerL)rr%rr&rrLrerL)rr(rr)rrLrerL)rr+rr,rrLrerL)rr.rr:rrLrerL)rr0rr1rrLrerL)rr3rr4rrLrerL)rr6rr7rrLrerL)rr9rr:rrLrerL)rr<rr=rrLrerL)rr?rr@rrLrerL)rrBrrCrrLrerL)rrVrrErrLrerL)rHrLrerf)rrVrLr(rKrMrerN)rrVrLr(rKrMrer()F)rrSrTr]rerf)rNr) rrVrXr(rYr5rZr[r\rVrerf)rrVrbrcrTr]rerf)rgrhrTr]rir@rerf)NF) rgrhrtrVrurvrTr]rirwrerf)rrVrzr{rTr]rerf)rrVrr(rTr]rerf)rrVrrrTr]rerf)rrrTr]rerf) rrVrrVrzr{rTr]rerf) rrVrrVrrrTr]rerf)rrVrrrr]rerf)rNNrrNF)rrVrrVrrVrrrrrrVrrrTr]rerf)rNrF)rrVrrVrrVrrrrVrTr]rerf)rrrerf)rN) rrrrLrrrir(rerf)rrVrrLrir(rerf)rrVrrrr]rerf)rrVrrrerf)rzrrTr]rerf)rrnrrrerf)rzrrerf)rrVrrVrTr]rerf)rrrTr]rerf)rrrerf)rrVrrPrerfNN)rrVrrrrrerf)rrVrrPrerf)rrVrer])rrrerf)Drq __module__ __qualname____doc__rK__annotations__rrOrQrSrTsysstdoutstderrrpropertyrrrrrrrrrrrrr staticmethodrrrrJrrRrWr_rarfrlryr}rrrrrrrrrrrrrrrrrrrrrrrrrrNrrrJrJs "N!!!!OOO    F  G    F!!##J04!$"%*$  %*#nnnnn`$$$X$ CCCCB5555 bb67788   98 ;;;;2222BBBB++++ ;;;;;~4444///\/.  X  X X  X  X  X  X  X X  X  X  X  X  XX  X  X  X X  X  X  X  X$#X(  X"!X&  XX  X  XIL8,,,,;= UUUUUU2;=       2 > > > > >"13 3 3 3 3 3 j PPPPP45?5?5?5?5?v,0 "9"9"9"9"9JAF5/5/5/5/5/n+++++4BG+++++: < < < < <NSTTTTT4 PPPPP4BG99999. 8<+-P P P P P l 8<3 3 3 3 3 j!/!/!/!/F 4 4 4 4%) JJJJJX>>>>>BTYNNNNN0 % % % %VVVVV0:::: """""7; VVVVV& 1 1 1 1 %%%%N 2 2 2 2 2 2rrJc8eZdZdZ ddd Zdd ZddZddZdS)TemplateBridgezThis class defines the interface for a "template bridge", that is, a class that renders templates given a template name and a context. Nrr3theme Theme | Nonedirslist[str] | Nonererfc$d}t|)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 subclassesNotImplementedError)rrrrrs rrzTemplateBridge.inits2!#&&&rfloatcdS)zCalled 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``. rrNrs rnewest_template_mtimez$TemplateBridge.newest_template_mtime-s qrtemplaterVcontextdict[str, Any]c$d}t|)zCalled by the builder to render a template given as a filename with a specified context (a Python dictionary). rrrrrrs rrenderzTemplateBridge.render42!#&&&rc$d}t|)z}Called by the builder to render a template given as a string with a specified context (a Python dictionary). rrr s r render_stringzTemplateBridge.render_string;r"rr)rr3rrrrrerf)rer)rrVrrrerf)rrVrrrerV)rqrrrrrr!r$rNrrrrs{#!% '''''"''''''''''rr){r __future__rrrr  collectionsriortypingrrdocutils.parsers.rstrr|r r sphinx._cli.util.colourr sphinx.configr sphinx.environmentr sphinx.errorsrrr sphinx.eventsrsphinx.highlightingr sphinx.localersphinx.projectrsphinx.registryr sphinx.utilrrsphinx.util._pathlibrrsphinx.util.build_phasersphinx.util.displayrsphinx.util.i18nrsphinx.util.loggingrsphinx.util.osutilrrsphinx.util.tagsr oscollections.abcr!r"r#r$r%pathlibr&r'r(r)r*r+docutils.nodesr,r-docutils.parsersr.r/docutils.transformsr0pygments.lexerr1r2sphinx.buildersr3r4r5sphinx.domainsr6r7sphinx.environment.collectorsr8sphinx.ext.autodocr9r:sphinx.ext.todor;sphinx.extensionr<r=r>r?r@ sphinx.rolesrArrBsphinx.themingrCsphinx.util.docfieldsrDsphinx.util.typingrErFrGr _first_party_extensions_first_party_themesr getLoggerrqrzrJrrNrrrOs #""""" ********&&&&&& &&&&&&&&(((((( //////PPPPPPPPPP&&&&&&------""""""333333))))))));;;;;;;;......000000......11111111111111!!!!!!= IIIMMMMMMMMMMMMMM............,,,,,,,,''''''......------$$$$$$''''''22222222,,,,,,,,BBBBBBOOOOOOOO))))))****** &%%%%%,,,,,,$$$$$$++++++<<<<<<<<1'1111d))--*  8 $ $G2G2G2G2G2G2G2G2T4)')')')')')')')')')'r