ó ‹²,]c@s¦dZddlZddlZddljZddlZddlZddlm Z ddl m Z ddl m Z ddlmZmZddlZddlmZddlmZmZmZdd lmZed ƒZejed d ƒZejed ƒZeddejddedƒddƒZeddejddeƒddƒZd„Z d„Z!d„Z"ddde#e#dd„Z$dd„Z%d„Z&dS(s 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 Copyright (C) 2009 Tim Dumol Copyright (C) Spyder Project Contributors Distributed under the terms of the BSD License Taken from the Sage project (www.sagemath.org). See here for the original version: www.sagemath.org/doc/reference/sagenb/misc/sphinxify.html iÿÿÿÿN(tmkdtemp(tescape(t SystemMessage(t EnvironmenttFileSystemLoader(tSphinx(t_tget_module_data_pathtget_module_source_path(tencodingsspyder.utils.helptstatictcsstjstspydertrelpathtutilsthelptmathjaxt attr_namet MATHJAXPATHt JQUERYPATHcCsd|kpd|kS(s;Returns whether a string contains Sphinx-style ReST markup.t`s::((t docstring((s:lib/python2.7/site-packages/spyder/utils/help/sphinxify.pytis_sphinx_markupBscCsItƒ}ttjtdƒƒ|_|jdƒ}|jdtd|ƒS(s-Print a warning message on the rich text viewt templatess warning.htmltcss_pathttext( RRtosptjoint CONFDIR_PATHtloadert get_templatetrendertCSS_PATH(tmessagetenvtwarning((s:lib/python2.7/site-packages/spyder/utils/help/sphinxify.pyR$Hs c Cs[tƒ}ttjtdƒƒ|_|jdƒ}|jdtd|d|d|d|ƒS(s+Print a usage message on the rich text viewRs usage.htmlRttitlet intro_messagettutorial_messagettutorial( RRRRRRRR R!(R%R"R'R(R#tusage((s:lib/python2.7/site-packages/spyder/utils/help/sphinxify.pyR)Ps  tcCs¬|r*tjdkr*|jddƒ}ni |r9dndd6|d6|d6|d 6|d 6|d 6td 6td 6td6td6tjdkr”dndd6t j d6}|S(sH 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 tnts\t/ttrueR*tmath_ontnametargspectnotetcollapsetimg_pathRtjs_patht jquery_patht mathjax_paths1.1tright_sphinx_versiontplatform( tosR/treplaceR!tJS_PATHt JQUERY_PATHt MATHJAX_PATHtsphinxt __version__tsysR8(R/R0R1tmathR2R3tcontext((s:lib/python2.7/site-packages/spyder/utils/help/sphinxify.pytgenerate_contextYs  thtmlcCsƒtƒ}tj|ƒ}tj|dƒ}tj|dƒ}|dkrQd}nd}tj|d|ƒ}|dr–|dr–|jd d ƒ}nt|d ƒ}x:d d ddddgD] } |j| d| dƒ}q¿W||d stwR sutf-8sspyder.utils.helpt html_contexttdoctreeststatusR$tfreshenvtwarningiserrorttagss`It was not possible to generate rich text help for this object.
Please see it in plain text.trs
s
t
ignore_errorsN(RR	tto_unicode_from_fsRRR:RtcodecstopentwritetclosetFalsetgenerate_configurationRRtNonetTruetbuildRRR$texiststreadtshutiltrmtree(RRBtbuildernametsrcdirtdestdirtrst_nametsuffixtoutput_nameR0tchartdoc_filettemp_confdirtconfdirt
confoverridest
doctreedirt
sphinx_apptoutput((s:lib/python2.7/site-packages/spyder/utils/help/sphinxify.pyt	sphinxify‘sV			


	



cCsßtjtdƒdƒ}tjtjtdƒdƒ}tjtj|dƒƒtjtj|dƒƒtj||ƒtj|tj|dƒƒttj|dƒdƒj	dƒttj|dd	ƒdƒj	dƒd
S(s‹
    Generates a Sphinx configuration in `directory`.

    Parameters
    ----------
    directory : str
        Base directory to use
    sspyder.utils.helpsconf.pyRslayout.htmlR
s__init__.pyRKR*temptyN(
RRRRR9tmakedirsR`tcopyRVRW(t	directorytconftlayout((s:lib/python2.7/site-packages/spyder/utils/help/sphinxify.pyRZîs	"('t__doc__RUR9tos.pathtpathRR`R@ttempfileRtxml.sax.saxutilsRtdocutils.utilsRtjinja2RRR>tsphinx.applicationRtspyder.config.baseRRRtspyder.utilsR	RRR!R;R=R<RR$R)RYRCRpRZ(((s:lib/python2.7/site-packages/spyder/utils/help/sphinxify.pyts>										7]