k7i^SrSSKJr SrSSKrSSKrSSKrSSKrSSKrSSK J r J r J r J r JrJrJrJr SSKJr SSKJr Sr\(a SS KJr SS KJr "S S 5rS rSrSSSSSSSSSSSS\\4SjrS'SjrS(Sjr S\ RBSSSSSSSSSSSS4Sjr"S\ RBSSSSSSSSS4 Sjr#S)Sjr$SSSSSSSSSSSS\\S\ RJ4Sjr&S*Sjr'Sr(S+S*Sjjr)S*Sjr*S*Sjr+S*Sjr,S*S jr-S*S!jr.S*S"jr/S*S#jr0S*S$jr1S*S%jr2S*S&jr3g),a Calling the ``publish_*`` convenience functions (or instantiating a `Publisher` object) with component names will result in default behavior. For custom behavior (setting component options), create custom component objects first, and pass *them* to ``publish_*``/`Publisher`. See `The Docutils Publisher`_. .. _The Docutils Publisher: https://docutils.sourceforge.io/docs/api/publisher.html ) annotationsreStructuredTextN) __version____version_details__ SettingsSpecioutilsreadersparserswriters) OptionParser)doctreeF)TextIO)StrPathcR\rSrSrSrSSSS\R S\RS4SSjjrSSSjjr SSjr SSjr SSjr SS jr SS jrSSS jjrSSS jjrSSS jjrSSSjjrSSjrSSjrSSjrSSjrSSjrSSjrSSjrSrg) Publisher%zC A facade encapsulating the high-level logic of a Docutils system. Nc n[U[5(a[R"U5"U5n[U[5(ae[U[R5(a+UR cUR U5 UR nO[R"U5"5n[U[5(a[R"U5"5nSUl Xl X lX0l X@lXPlX`lXplXl[&R("5Ulg)z Initial setup. The components `reader`, `parser`, or `writer` should all be specified, either as instances or via their names. N) isinstancestrr get_reader_classReaderparser set_parserr get_parser_classr get_writer_classdocumentreaderwritersource source_class destinationdestination_classsettingsr ErrorOutput_stderr) selfrrrr r!r"r#r$s G/home/james-whalen/.local/lib/python3.13/site-packages/docutils/core.py__init__Publisher.__init__+s fc " "--f5f=F fc " "&'..11==(%%f- 11&9; fc " "--f57F ; 3 3 3 G(?& "3D  J~~' c[R"U5nU"X#5UlURRbURRUlgURbURURlgg)zpSet `self.reader` by name. The "paser_name" argument is deprecated, use "parser" with parser name or instance. N)r rrr)r'rr parser_name reader_classs r( set_readerPublisher.set_readeras` //7 "67 ;;   )++,,DK [[ $!%DKK %r+cH[R"U5nU"5Ulg)zSet `self.writer` by name.N)r rr)r' writer_name writer_classs r( set_writerPublisher.set_writerns// < "n r+c|[R"S[SS9 URcUR XR U5 UR cMURR cURR U5 URR UlURcURU5 gg)Nzh`Publisher.set_components()` will be removed in Docutils 2.0. Specify component names at instantiation. stacklevel) warningswarnPendingDeprecationWarningrr/rrrr4)r' reader_namer-r2s r(set_componentsPublisher.set_componentsss *0A ? ;;  OOKk B ;; {{!!) &&{3++,,DK ;;  OOK ( r+c [R"5 [R"S[S9 U(aGU(d [ 5nXClUR 5n[U5S:aUSS:XaS/Ul[URURURU4USXS9sSSS5 $!,(df  g=f) Nignore)category application applicationsT) componentsdefaultsread_config_filesusage description) r:catch_warningsfilterwarningsDeprecationWarningrconfig_sectionsplitlenconfig_section_dependenciesr rrr)r'rJrK settings_specrOrHpartss r(_setup_settings_parser Publisher._setup_settings_parsers  $ $ &  # #H7I J$$0NM/=,&,,.u:>eBi=&@AO@PM= KKdkk)+!T 6' & &s BB55 Cc lUR"XX440UD6nUR5UlUR$)aK Return settings from components and config files. Please set components first (`self.set_reader` & `self.set_writer`). Use keyword arguments to override component defaults (before updating from configuration files). Calling this function also sets `self.settings` which makes `self.publish()` skip parsing command line options. )rUget_default_valuesr$)r'rJrKrSrOrH option_parsers r( get_settingsPublisher.get_settingss=33  KAIK %88: }}r+cURcAU(aUR5O0nURSS5 UR"SUUS.UD6 gg)N tracebackT)rSrO)r$copy setdefaultrZ)r'rSsettings_overridesrOrHs r(process_programmatic_settings'Publisher.process_programmatic_settingssV == 4F)..0BH    T 2    *M-; * ( * !r+c UR"X#XE40UD6nUc[RSSnURU5Ulg)z Parse command line arguments and set ``self.settings``. Pass an empty sequence to `argv` to avoid reading `sys.argv` (the default behaviour). Set components first (`self.set_reader` & `self.set_writer`). NrC)rUsysargv parse_argsr$)r'rfrJrKrSrOrHrYs r(process_command_linePublisher.process_command_linesI33  KAIK <88AB> H) AH$$H)cbUR(dgURR(aP[SURS9 [[ R "URR5URS9 URR(aP[SURS9 [[ R "URR5URS9 URR(a[SURS9 [SURS9 [[ R "URRRVVVVs/sH9upp4XR<SUR<3U=(a URU4PM; snnnn5URS9 URR(aP[SURS9 [URR 5R!S5URS9 ggs snnnnf) Nz ::: Runtime settings:filez ::: Document internals:z ::: Transforms applied:z@ (priority, transform class, pending node details, keyword args).z ::: Pseudo-XML:raw_unicode_escape)rr$ dump_settingsprintr&pprintpformat__dict__dump_internalsdump_transformsrapplied __module____name__detailsdump_pseudo_xmlencode)r'priorityxclasspendingkwargss r(rPublisher.debugging_dumps's}}  == & & +$,, ? &..!7!78t|| L == ' ' -DLL A &..!7!78t|| L == ( ( -DLL A "(,  6 &..MM--55767Xw'8'8&//J-goov7678?Cll  L == ( ( %DLL 9 $--'')00$&,0LL : ) 7s&AH)c URR5(aURR5(dg[R S:XaSOSnSnSnUR RSnURRSn[S[S US US US 3 URS 9 g![a gf=f![[4a NHf=f)z=Print info and prompt when waiting for input from a terminal.NntzCtrl+ZzCtrl+Dzuseful formatsrz Docutils z/ converting "z" into "zT". Call with option "--help" for more info. .. Waiting for source text (finish with z on an empty line):r) r isattyr&AttributeErrorrunamer supportedr IndexErrorrr)r'eot_key in_format out_formats r(rPublisher.prompt>s KK&&((T\\-@-@-B-B.C!ggo(8 %   --a0I..q1J  +'&Kx |<99@ B## <<  !    +   s#>B72C7 CCCCc[U[R5(aURU5 g[U[5(aUR U5 g[U[ R5(a3URRS[ R"U5-5 g[U[ R5(a3URRS[ R"U5-5 g[S[ R"U5-URS9 [S[[(a S[S3OSS [R R#5S S 3URS9 g) Nz-Unable to open source file for reading: %s z2Unable to open destination file for writing: %s z%srzExiting due to error. Use "--traceback" to diagnose. Please report errors to . Include "--traceback" output, Docutils version (z []r), Python version (rz5), your OS type & version, and the command line used.)rr SystemMessagereport_SystemMessageUnicodeEncodeErrorreport_UnicodeErrorr InputErrorr&r error_string OutputErrorrrrreversionrPr'rs r(rPublisher.report_ExceptionTs- eU00 1 1  % %e , 1 2 2  $ $U + r}} - - LL   (*,//%*@ A B r~~ . . LL  ??512 3 $//dll C 12= 3 32!<=""$Q'()  %)LL  2r+c[SUR<S[RRUR<S3UR S9 g)NzExiting due to level-z (z) system message.r)rlevelr Reporterlevelsr&rs r(rPublisher.report_SystemMessagejs3 ++u~~44U[[AC<< !r+cURURURnURR [ R "U5<SURR<SURSS5<SURSS5<SURR<S[<S [RR5S <S 35 g) Nz! The specified output encoding (z) cannot handle all of the output. Try setting "--output-encoding-error-handler" to * "xmlcharrefreplace" (for HTML & XML output); the output will contain "asciixmlcharrefreplacezU" and should be usable. * "backslashreplace" (for other output formats); look for "backslashreplacezr" in the output. * "replace"; look for "?" in the output. "--output-encoding-error-handler" is currently set to "z". Exiting due to error. Use "--traceback" to diagnose. If the advice above doesn't eliminate the error, please report it to . Include "--traceback" output, Docutils version (rrz6), your OS type & version, and the command line used. )objectstartendr&rrrr$rrrrrerrP)r'rdatas r(rPublisher.report_UnicodeErroros||EKK 2 *u%}},,{{7$78{{7$67}}::CKK--/23 4 5r+) r&r"r#rrrr$r r!rreturnNone)NN)NNNN)NNNNN)r z str | NonerkStrPath | Nonerr)r"z TextIO | Nonerlrrr)NNNNNNF)rr __qualname____firstlineno____doc__r FileInput FileOutputr)r/r4r>rUrZrbrhrormrnrrrrrrr__static_attributes__r^r+r(rr%s#42<<!R]]4($(4(l -% )>BBF6,488<" *9= *GK@D7,07"D)-15 F% F . F F6:;?G%2G*8G"G>5 :>7;8=(T:.!,2,! 5r+rz*%prog [options] [ []]zReads from (default is stdin) and writes to (default is stdout). See https://docutils.sourceforge.io/docs/user/config.html for a detailed settings reference.Tc [XU5 U=(d U=(d SnU=(d U=(d SnU=(d U=(d Sn[XXFS9nURXXUXS9nU$)a( Set up & run a `Publisher` for command-line-based file I/O (input and output file paths taken automatically from the command line). Also return the output as `str` or `bytes` (for binary output document formats). Parameters: see `publish_programmatically()` for the remainder. - `argv`: Command-line argument list to use instead of ``sys.argv[1:]``. - `usage`: Usage string, output if there's a problem parsing the command line. - `description`: Program description, output for the "--help" option (along with command-line option descriptions). standalonerestructuredtext pseudoxml)r$rOr)_name_arg_warningrr)rr=rr-rr2r$rSrarOrrfrJrK publisherr{s r(publish_cmdlinersp,k <  2{ 2lF  8{ 8&8F  1{ 1kF&&DI    [1C%NF Mr+c[XWU 5 [S0S[R_SU_SU_S[R_SU_SU_SU_SU_S U_S U_S U_S U _S U _SU _SU _SU _SU_6unnU$)z Set up & run a `Publisher` for programmatic use with file-like I/O. Also return the output as `str` or `bytes` (for binary output document formats). Parameters: see `publish_programmatically()`. r!r rkr#r"rlrr=rr-rr2r$rSrarOrr^)rpublish_programmaticallyrrr)r rkr"rlrr=rr-rr2r$rSrarOrr{ _publishers r( publish_filersk <1 /\\ /*0 />I /-- /  /3C / /$/ /  / $/ /  / $/ / /*7 /. /& /. /FJ Mr+c[XFU5 [S0S[R_SU_SU_S[R_SS_SU_SU_S U_S U_S U_S U_S U_SU _SU _SU _SU _SU _6upU$)u` Set up & run a `Publisher` for programmatic use with string I/O. Accepts a `bytes` or `str` instance as `source`. The output is encoded according to the `output_encoding`_ setting; the return value is a `bytes` instance (unless `output_encoding`_ is "unicode", cf. `docutils.io.StringOutput.write()`). Parameters: see `publish_programmatically()` or https://docutils.sourceforge.io/docs/api/publisher.html#publish-string This function is provisional because in Python 3 name and behaviour no longer match. .. _output_encoding: https://docutils.sourceforge.io/docs/user/config.html#output-encoding r!r rkr#r"Nrlrr=rr-rr2r$rSrarOrr^)rrr StringInput StringOutput)r rkrlrr=rr-rr2r$rSrarOrr{rs r(publish_stringrs4k <1 /^^ /,2 /@K /// / /,< / /$/ /  / $/ /  / $/ / /*7 /. /& /. /F Mr+c[XWU 5 [S0SU_SU_SU_S[R_SS_SU_SU_S U_S U_S U_S U_S U _SU _SU _SU _SU _SU_6unnURR $)a Set up & run a `Publisher`, and return a dictionary of document parts. Dictionary keys are the names of parts. Dictionary values are `str` instances; encoding is up to the client, e.g.:: parts = publish_parts(...) body = parts['body'].encode(parts['encoding'], parts['errors']) See the `API documentation`__ for details on the provided parts. Parameters: see `publish_programmatically()`. __ https://docutils.sourceforge.io/docs/api/publisher.html#publish-parts r rkr!r#r"Nrlrr=rr-rr2r$rSrarOrr^)rrrrrrT)r rkr!rlrr=rr-rr2r$rSrarOr_outputrs r( publish_partsr s2k <1 / /#. /=I /// / /,< / /$/ /  / $/ /  / $/ / /*7 /. /& /. /GY    ! !!r+c [XFS5 [S0SU_SU_SU_SS_SS_S[R_SU_S U_S U_S U_S S _SS_SU_SU_SU _SU _SU _6upU R$)zy Set up & run a `Publisher` for programmatic use. Return a document tree. Parameters: see `publish_programmatically()`. Nr rkr!r"rlr#rr=rr-rnullr2r$rSrarOrr^)rrr NullOutputr)r rkr!rr=rr-r$rSrarOrrrs r(publish_doctreer2sk51 / /#. /! / /,0 /-- /  / $/ /  / $/ / /$( / /*7 /. /?M /. /G   r+c *[SSU5 [[R"5U=(d U=(d S[R "U5[R US9n U RXVU5 U RSU5 U RUS9$)u Set up & run a `Publisher` to render from an existing document tree data structure. For programmatic use with string output (`bytes` or `str`, cf. `publish_string()`). Note that ``document.settings`` is overridden; if you want to use the settings of the original `document`, pass ``settings=document.settings``. Also, new `document.transformer` and `document.reporter` objects are generated. Parameters: `document` is a `docutils.nodes.document` object, an existing document tree. Other parameters: see `publish_programmatically()`. This function is provisional because in Python 3 name and behaviour of the `io.StringOutput` class no longer match. Nr)rrr r#r$r) rrrrr DocTreeInputrrbrnr) rrlrr2r$rSrarOrrs r(publish_from_doctreerOs2dD+.!1!'!E;!E+!#!:,.OO#+ -I ++>; d$45   0B  CCr+rrrc [R"S[SS9 [XXFUS9nUR XU5 UR XXUXS9nU$)u Set up & run a `Publisher` for command-line-based file I/O (input and output file paths taken automatically from the command line). Also return the output as `bytes`. This is just like publish_cmdline, except that it uses io.BinaryFileOutput instead of io.FileOutput. Parameters: see `publish_programmatically()` for the remainder. - `argv`: Command-line argument list to use instead of ``sys.argv[1:]``. - `usage`: Usage string, output if there's a problem parsing the command line. - `description`: Program description, output for the "--help" option (along with command-line option descriptions). Deprecated. Use `publish_cmdline()` (works with `bytes` since Docutils 0.20). Will be removed in Docutils 0.24. zg"publish_cmdline_to_binary()" is obsoleted by "publish_cmdline()" and will be removed in Docutils 0.24.r7r8)r$r#r)r:r;rNrr>r)rr=rr-rr2r$rSrarOrrfrJrKr"r#rr{s r(publish_cmdline_to_binaryrtsg@ MM'(:qJ&&,=?I [{C    [1C%NF Mr+c [SU5H.upUcM [R"SUSUSUS3[SS9 M0 g)N)rrrz Argument "z1_name" will be removed in Docutils 2.0. Specify z name in the "z " argument.r8)zipr:r;r<) name_args componentname_args r(rrsS"#A9M   MMJyk244=;?%%.K{<4 C Nr+c  U=(d U=(d SnU=(d U =(d SnU =(d U =(d Sn [XhXUUS9nURXU5 URX5 URXE5 UR US9nUU4$)aD Set up & run a `Publisher` for custom programmatic use. Return the output (as `str` or `bytes`, depending on `destination_class`, writer, and the "output_encoding" setting) and the Publisher object. Internal: Applications should not call this function directly. If it does seem to be necessary to call this function directly, please write to the Docutils-develop mailing list . Parameters: * `source_class` **required**: The class for dynamically created source objects. Typically `io.FileInput` or `io.StringInput`. * `source`: Type depends on `source_class`: - If `source_class` is `io.FileInput`: Either a file-like object (must have 'read' and 'close' methods), or ``None`` (`source_path` is opened). If neither `source` nor `source_path` are supplied, `sys.stdin` is used. - If `source_class` is `io.StringInput` **required**: The input as either a `bytes` object (ensure the 'input_encoding' setting matches its encoding) or a `str` object. * `source_path`: Type depends on `source_class`: - `io.FileInput`: Path to the input file, opened if no `source` supplied. - `io.StringInput`: Optional. Path to the file or name of the object that produced `source`. Only used for diagnostic output. * `destination_class` **required**: The class for dynamically created destination objects. Typically `io.FileOutput` or `io.StringOutput`. * `destination`: Type depends on `destination_class`: - `io.FileOutput`: Either a file-like object (must have 'write' and 'close' methods), or ``None`` (`destination_path` is opened). If neither `destination` nor `destination_path` are supplied, `sys.stdout` is used. - `io.StringOutput`: Not used; pass ``None``. * `destination_path`: Type depends on `destination_class`: - `io.FileOutput`: Path to the output file. Opened if no `destination` supplied. - `io.StringOutput`: Path to the file or object which will receive the output; optional. Used for determining relative paths (stylesheets, source links, etc.). * `reader`: A `docutils.readers.Reader` instance, name, or alias. Default: "standalone". * `reader_name`: Deprecated. Use `reader`. * `parser`: A `docutils.parsers.Parser` instance, name, or alias. Default: "restructuredtext". * `parser_name`: Deprecated. Use `parser`. * `writer`: A `docutils.writers.Writer` instance, name, or alias. Default: "pseudoxml". * `writer_name`: Deprecated. Use `writer`. * `settings`: A runtime settings (`docutils.frontend.Values`) object, for dotted-attribute access to runtime settings. It's the end result of the `SettingsSpec`, config file, and option processing. If `settings` is passed, it's assumed to be complete and no further setting/config/option processing is done. * `settings_spec`: A `docutils.SettingsSpec` subclass or object. Provides extra application-specific settings definitions independently of components. In other words, the application becomes a component, and its settings data is processed along with that of the other components. Used only if no `settings` specified. * `settings_overrides`: A dictionary containing application-specific settings defaults that override the defaults of other components. Used only if no `settings` specified. * `config_section`: A string, the name of the configuration file section for this application. Overrides the ``config_section`` attribute defined by `settings_spec`. Used only if no `settings` specified. * `enable_exit_status`: Boolean; enable exit status at end of processing? rrr)r$r!r#r)rrbrmrnr)r!r rkr#r"rlrr=rr-rr2r$rSrarOrrr{s r(rrsL 2{ 2lF  8{ 8&8F  1{ 1kF&&'3,=?I++>; - k<   2D  EF 9 r+c SUSUS3[-n[R"[RS5 [XS9 g![Ra-n[ R RSUS35 SnANFSnAff=f)Nz Generate zZ documents from standalone reStructuredText sources . rz(WARNING: Cannot set the default locale: z. )rrK) default_descriptionlocale setlocaleLC_ALLErrorrestderrrr)r documenttypedoc_pathrKes r( rst2somethingr!s L>"119 $ @   L+6; <<L CA3cJKKLs%AB#A==Bc[SSS5 g)NhtmlHTMLzuser/html.html#htmlrr^r+r(rst2htmlr2s&&"78r+c[SSS5 g)Nhtml4z XHTML 1.1zuser/html.html#html4css1rr^r+r( rst2html4r6s';(BCr+c[SSS5 g)Nhtml5HTML5zuser/html.html#html5-polyglotrr^r+r( rst2html5r:s'7$CDr+c[SSS5 g)NlatexLaTeXuser/latex.htmlrr^r+r( rst2latexr$>s'7$56r+c[SSS5 g)NmanpagezUnix manual (troff)zuser/manpage.htmlrr^r+r(rst2manr'Bs)24GHr+c[SSS5 g)NodtzOpenDocument text (ODT)z user/odt.htmlrr^r+r(rst2odtr*Fs%2ODr+c[SSS5 g)Nrzpseudo-XML (test)ref/doctree.htmlrr^r+r( rst2pseudoxmlr-Js+24FGr+c[SSS5 g)Ns5zS5 HTML slideshowzuser/slide-shows.htmlrr^r+r(rst2s5r0Ns$+-DEr+c[SSS5 g)NxetexzLaTeX (XeLaTeX/LuaLaTeX)r#rr^r+r( rst2xetexr3Rs'57HIr+c[SSS5 g)NxmlzDocutils-native XMLr,rr^r+r(rst2xmlr6Vs%.0BCr+)NNNNNNNNNNNNNNF) NNNNNNNNNNNNF)NNNNNNNFr)r)4r __future__r __docformat__r rrurer:docutilsrrrrr r r r docutils.frontendr docutils.readersr TYPE_CHECKINGtypingrdocutils.nodesrr default_usager rrrrrrrBinaryFileOutputrrrrrrrr$r'r*r-r0r3r6r^r+r(rAs #" <<<*$ &f5f5R = ) TTT!'+D'+$'5H D+/48*.*.*.GK9> >?C,0,0,004;?&+ 'T'+#'444t%)$%*&"R)-!#TT!'+D', :59266:AE,1 "DJ&*|%)7I%){'+,015-115#'$1*=*.020C0C)XCrp<"9DE7IEHFJDr+