G@d' dZddlZddlZddlmZddlZddlZddlZddl m Z ddl m Z ddl mZddlmZmZddlZddlmZddlmZmZmZdd lmZed Zejed d Zejed d Zejed dZejedZ edejdde ddZ!edejdde dZ"dZ#efdZ$efdZ%efdZ&ddddddefdZ'd!dZ(d Z)dS)"ad Process docstrings with Sphinx. **AUTHORS**: * Tim Joseph Dumol (2009-09-29): Initial version. * The Spyder Project Contributors: Several changes to make it work with Spyder. Originally based on sagenb/misc/sphinxify.py from the `Sage Notebook project `_, part of the `SageMath `_ system. N)mkdtemp)escape) SystemMessage) EnvironmentFileSystemLoader)Sphinx)_get_module_data_pathget_module_source_pathencodingspyder.plugins.help.utilsstaticcssdark_cssbase_cssjsspyderutilshelpmathjax MATHJAXPATH)relpath attr_name JQUERYPATHcd|vpd|vS)z;Returns whether a string contains Sphinx-style ReST markup.`z::) docstrings Clib/python3.11/site-packages/spyder/plugins/help/utils/sphinxify.pyis_sphinx_markupr!Is 9  1 12ct}ttjtd|_|d}|||S)z-Print a warning message on the rich text view templatesz warning.html)css_pathtextrrospjoin CONFDIR_PATHloader get_templaterender)messager%envwarnings r r0r0OsO --C!#(<"E"EFFCJ~..G >>8'> : ::r"ct}ttjtd|_|d}||||||S)z+Print a usage message on the rich text viewr$z usage.html)r%title intro_messagetutorial_messagetutorialr')r2r.r4r5r%r/usages r r6r6Wsb --C!#(<"E"EFFCJ   \ * *E <<g)9H  N NNr"ct}ttjtd|_|d}||||S)z,Print loading message on the rich text view.r$z loading.html)r% loading_imgr.r')r.r8r%r/loadings r r9r9`s^ --C!#(<"E"EFFCJ~..G >>{G  E EEr"Fc|r&tjdkr|dd}|rdnd|||||t|tt t tjdkrdndtjdkrdndtj d}|S) aD Generate the html_context dictionary for our Sphinx conf file. This is a set of variables to be passed to the Jinja template engine and that are used to control how the webpage is rendered in connection with Sphinx Parameters ---------- name : str Object's name. note : str A note describing what type has the function or method being introspected argspec : str Argspec of the the function or method being introspected math : bool Turn on/off Latex rendering on the OI. If False, Latex will be shown in plain text. collapse : bool Collapse sections img_path : str Path for images relative to the file containing the docstring Returns ------- A dict of strings to be used by Jinja to generate the webpage nt\/truer:z1.1z2.0)math_onnameargspecnotecollapseimg_path base_css_pathr%js_path jquery_path mathjax_pathright_sphinx_versionsphinx_version_2platform) osrAreplace BASE_CSS_PATHJS_PATH JQUERY_PATH MATHJAX_PATHsphinx __version__sysrL)rArBrCmathrDrEr%contexts r generate_contextrXis>/BGtOO##D#..  'R$ "$*$6$>$>bbF & 2U : :"",! ( Nr"htmlc tjtd}t}t j|}tj|d}d}t jdkrwtj |j d}tj |j d}||k}|r1t}t j|}t|tj|d} |dkrd} nd } tj|d | z} |d r4|d r,| d d}| dd}t|d} dD]} | | d| zdz} | |d<tj| dd}|||d|i}tj|d}t%||||||ddddd } |d| gn.#t($r!t+d}t-|cYSwxYwtj| r@tj| dd}| dd }nt+d}t-|S|rt3j|d!t3j|d!|S)"a  Runs Sphinx on a docstring and outputs the processed documentation. Parameters ---------- docstring : str a ReST-formatted docstring context : dict Variables to be passed to the layout template to control how its rendered (through the Sphinx variable *html_context*). buildername: str It can be either `html` or `text`. Returns ------- An Sphinx-processed string, in either HTML or plain text format, depending on the value of `buildername` r_buildFr<rz docstring.rstrYz.htmlz.txtrrJr@z\\z\\\\z\**rB)=,()r\z**z zwzutf-8r html_contextdoctreesNT)statusr0freshenvwarningiserrortagsz`It was not possible to generate rich text help for this object.
Please see it in plain text.rz
z
)
ignore_errors)r(r)rrr
to_unicode_from_fsrMrApathlibPathpartsgenerate_configurationrNrcodecsopenwritecloserbuildrr	r0existsreadshutilrmtree)rrWbuildernameconfdirsrcdirdestdirtemp_confdir_needed
drive_confdirdrive_srcdirrst_namesuffixoutput_namerBchardoc_file
confoverrides
doctreedir
sphinx_appoutputs                   r 	sphinxifyrs',h-.IJJKKG
YYF

(
0
0Fhvx((G	w$ W--3A6
|F++1!4+|;	,iiG1'::G"7+++x00Hf(7K&$899K%&279+=2%%fj99	%%eS11	WY'((G/PP//$;dBYNPP GI{8S7;;;HNN9NN#W-M&*--J*k%dD!%e$HHHJz****344v	z+[#@@@EEGG)FGG344v3
gT2222
M&----MsH(IIctjtdd}tjtjtdd}t	jtj|dt	jtj|dt
j||t
j|tj|dttj|dd	dttj|dd	d	dd
S)z
    Generates a Sphinx configuration in `directory`.

    Parameters
    ----------
    directory : str
        Base directory to use
    rzconf.pyr$zlayout.htmlrz__init__.pyrar:emptyN)
r(r)rr*rMmakedirsrvcopyrprq)	directoryconflayouts   r rnrn	s8*+FGGDXch|[99=
I
IFKK00111KH--...
Ki   
KK88999)]	+	+S1177;;;)Xw	/	/55;;B?????r")rY)*__doc__rorMos.pathpathr(rkrvrUtempfilerxml.sax.saxutilsrdocutils.utilsrjinja2rrrSsphinx.applicationrspyder.config.baser	r
rspyder.utilsr
r*r)CSS_PATH
DARK_CSS_PATHrOrPrRrQr!r0r6r9rXrrnrr"r rs


				







######:9999900000000



%%%%%%8888888888!!!!!!&%&ABB38L(E22x<<
x<<
#(<
&
&$#H,4CHWf5