_OgSrSSKrSSKrSSKrSSKrSSKJr \R(aSSK J r "SS5r "SS\R5r \"S S /\RS 9"S S \ 55r"SS\5r"SS\R5r"SS\R5r\"SS /\RS 9"SS\ 55r\"SS /\RS 9"SS\ 55r"SS\ 5r"SS\ 5r"SS\R5r"S S!\R5r\"S"S /\RS 9"S#S$\ 55rg)%z This module defines the interfaces that can to be implemented for Pydoc-Markdown to implement custom loaders for documentation data, processors or renderers. N)Union)ApiSuitec*\rSrSrSrS\SS4SjrSrg)Context'z> Context data that is passed to plugins when they are loaded. directoryreturnNcXlgNr)selfrs ^/Users/admin/workspace/ai/Jarvis/env/lib/python3.13/site-packages/pydoc_markdown/interfaces.py__init__Context.__init__,s"r )__name__ __module__ __qualname____firstlineno____doc__strr__static_attributes__rrrr's###$#rrc&\rSrSrS\SS4SjrSrg) PluginBase0contextr Ncgr r)r rs rinitPluginBase.init1 rr)rrrrrrrrrrrr0s G  rrz!!pydoc_markdown.interfaces.Loaderz)stylecr\rSrSrSr\R S\R\ R4Sj5r Sr g)Loader5z This interface describes an object that is capable of loading documentation data. The location from which the documentation is loaded must be defined with the configuration class. r cgr rr s rload Loader.loadC rrN) rrrrrabcabstractmethodtIterabledocspecModuler(rrrrr$r$5s5   ajj0  rr$c\rSrSrSrg) LoaderErrorHrN)rrrrrrrrr2r2Hsrr2cz\rSrSrSr\R S\RS\ S\ R\ 4Sj5r Sr g) ResolverLzV A resolver can be used by a #Processor to replace cross references with a hyperlink. scoperefr cgr r)r r7r8s r resolve_refResolver.resolve_refQr*rrN)rrrrrr+r,r/ ApiObjectrr-Optionalr:rrrrr5r5LsD  !2!2  C  rr5c \rSrSrSr\R SSS\RS\ S\ R\R4Sj5r S r g ) ResolverV2VzNew style interface for resolving based on a text ref from in the context of a #docspec.ApiObject to find another. This is different from #Resolver because it returns the resolved object directly, instead of some string representation of it. suiterr7r8r cgr r)r rAr7r8s rresolve_referenceResolverV2.resolve_reference\r*rrN)rrrrrr+r,r/r<rr-r=rCrrrrr?r?VsW   z ':K:K RU Z[ZdZdelevevZw  rr?z$!pydoc_markdown.interfaces.Processorc\rSrSrSr\R S\R\ RS\R\ SS4Sj5r Srg) Processoraz A processor is an object that takes a list of #docspec.Module#s as an input and transforms it in an arbitrary way. This usually processes docstrings to convert from various documentation syntaxes to plain Markdown. modulesresolverr Ncgr rr rHrIs rprocessProcessor.processor*rr)rrrrrr+r,r-Listr/r0r=r5rLrrrrrFrFasM   qvvgnn5 HAU Z^  rrFz#!pydoc_markdown.interfaces.Rendererc.\rSrSrSrS\R \RS\R\ SS4Sjr S\R \RS\R\ 4Sjr \ RS\R \RSS4S j5rS rg) Rendererta A renderer is an object that takes a list of #docspec.Module#s as an input and produces output files or writes to stdout. It may also expose additional command-line arguments. There can only be one renderer at the end of the processor chain. Note that sometimes a renderer may need to perform some processing before the render step. To keep the possibility open that a renderer may implement generic processing that could used without the actual rendering functionality, #Renderer is a subclass of #Processor. rHrIr Ncgr rrKs rrLRenderer.processr!rcgr rr rHs r get_resolverRenderer.get_resolversrcgr rrUs rrenderRenderer.renderr*rr)rrrrrr-rNr/r0r=r5rLrVr+r,rYrrrrrPrPts qvvgnn5 HAU Z^ AFF7>>$:qzz(?S  affW^^4   rrPc \rSrSrSr\R S S\RS\R\ RS\R\ SS4Sjj5rS rg) SinglePageRendererz( Interface for rendering a single page. NfprH page_titler cgr r)r r^rHr_s rrender_single_page%SinglePageRenderer.render_single_pages rrr )rrrrrr+r,r-TextIOrNr/r0r=rrarrrrr\r\s^ [_ (( %&VVGNN%; IJTW   rr\c \rSrSrSr\R S\RS\ RS\R\ \R4SS4Sj5rS rg) SingleObjectRendererz6 Interface for rendering a single #docspec.ApiObject. r^objoptionsr Ncgr r)r r^rgrhs r render_object"SingleObjectRenderer.render_objectr*rr)rrrrrr+r,r-rcr/r<DictrAnyrjrrrrreres^   w/@/@ 166RUWXW\W\R\K] bf  rrec\rSrSrSr\R S\4Sj5r\R S\ R4Sj5r S\ RS\ R4Sjr Sr g ) Servera% This interface describes an object that can start a server process for live-viewing generated documentation in the browser. #Renderer implementations may additionally implement this interface to advocate their compatibility with the `--server` and `--open` options of the pydoc-markdown CLI. r cgr rr's rget_server_urlServer.get_server_urlr*rcgr rr's r start_serverServer.start_serverr*rrLcU$)a  Called when the files generated by pydoc-markdown have been updated. This gives the implementation a chance to reload the server process. The default implementation returns the *process* unchanged. Returning #None will automatically call #start_server() afterwards. r)r rLs r reload_serverServer.reload_servers rrN)rrrrrr+r,rrr subprocessPopenrurxrrrrrorosn      j..  Z%5%5*:J:JrrocH\rSrSrSr\R S\SS4Sj5rSr g)Builderz This interface can be implemented additionally to the #Renderer interface to indicate that the renderer supports building another produce after the markdown files have been rendered. site_dirr Ncg)z Invoke the build. The *site_dir* is the directory in which the output files should be placed. Otherwise, the directory may be determined by the builder. Nr)r rs rbuild Builder.buildsrr) rrrrrr+r,rrrrrrr}r}s/   c d  rr}z'!pydoc_markdown.interfaces.SourceLinkercv\rSrSrSr\R S\RS\ R\ 4Sj5r Sr g) SourceLinkerz This interface is used to determine the URL to the source of an API object. Renderers can use it to place a link to the source in the generated documentation. rgr cgr r)r rgs rget_source_urlSourceLinker.get_source_urlr*rrN)rrrrrr+r,r/r<r-r=rrrrrrrrs=   '"3"3  3  rr)rr+rztypingr-r/ databind.corer TYPE_CHECKINGpydoc_markdown.util.docspecrrABCrFLATr$ Exceptionr2r5r?rFrPr\reror}rrrrrss,  ??4##  + **   Z     )  sww   . **      - **  z  ,     : SWW8  cgg  1 **  :  r