Je' dZddlZddlZddlmZddlZddlZddlZddl m Z ddl m Z ddl mZddlmZmZddlZddlmZddlmZmZmZdd lmZed Zej8ed d Zej8ed d Zej8ed dZej8edZ edej8dde ddZ!edej8dde dZ"dZ#efdZ$efdZ%efdZ&ddddddefdZ'd dZ(dZ)y)!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|vxsd|vS)z;Returns whether a string contains Sphinx-style ReST markup.`z::) docstrings E/usr/lib/python3/dist-packages/spyder/plugins/help/utils/sphinxify.pyis_sphinx_markupr!Is 9  1 12ct}ttjtd|_|j d}|j||S)z-Print a warning message on the rich text view templatesz warning.html)css_pathtextrrospjoin CONFDIR_PATHloader get_templaterender)messager%envwarnings r r0r0OsC -C!#((<"EFCJ~.G >>8'> ::r"ct}ttjtd|_|j d}|j|||||S)z+Print a usage message on the rich text viewr$z usage.html)r%title intro_messagetutorial_messagetutorialr')r2r.r4r5r%r/usages r r6r6WsS -C!#((<"EFCJ   \ *E <<g)9H  NNr"ct}ttjtd|_|j d}|j|||S)z,Print loading message on the rich text view.r$z loading.html)r% loading_imgr.r')r.r8r%r/loadings r r9r9`sO -C!#((<"EFCJ~.G >>{G  EEr"Fc|r%tjdk(r|jdd}|rdnd|||||t|tt t tjdkrdndtjdkrdndtjd}|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>BGGtO##D#.  R$ "$*$6$6$>bF & 2 2U :",,! ( Nr"c ^tjtd}t}t j |}tj|d}d}t jdk(rutj|jd}tj|jd}||k7}|r*t}t j |}t|tj|d} |dk(rd} nd } tj|d | z} |d r)|d r$|jd d}|jdd}t|d} dD]} | j| d| zdz} | |d<tj| dd}|j!||j#d|i}tj|d}t%||||||ddddd } |j'd| gtj.| r9tj| ddj1}|jdd }nt+d}t-|S|rt3j4|d!t3j4|d!|S#t($rt+d}t-|cYSwxYw)"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.rsthtmlz.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,hh-.IJKG
YF

(
(
0Fhhvx(G	ww$ W-33A6
||F+11!4+|;iG11':G"7+xx0Hf((7K&$89K%&79+=%%fj9	%%eS1	WY'(G/P//$;dBYNPP!GI{{8S7;HNN9NN#W-M&*-J*k%dD!%e$HJz*zz+[#@EEG)FG34v

gT2
MM&-M)34v	s!J

J,+J,ctjtdd}tjtjtdd}t	j
tj|dt	j
tj|dt
j||t
j|tj|dttj|ddjdttj|dd	djdy
)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88*+FGDXXchh|[9=
IFKKK01KKH-.
KKi 
KKK89)]	+S177;)Xw	/5;;B?r")r[)*__doc__rorMos.pathpathr(rkrvrUtempfilerxml.sax.saxutilsrdocutils.utilsrjinja2rrrSsphinx.applicationrspyder.config.baser	r
rspyder.utilsr
r*r)CSS_PATH
DARK_CSS_PATHrOrPrRrQr!r0r6r9rXrrnrr"r rs5	

#:0
%88!&&AB388L(E2x<
x<
#((<
&$H,4CHHWf5