B nb\"@s$dZddlZddlZddlmZddlZddlZddlm Z ddl m Z ddl m Z ddlmZmZddlZddlmZddlmZmZmZdd lmZed Zeed d Zeed ZededdedddZededdeddZddZ ddZ!ddZ"d$ddZ#d%d d!Z$d"d#Z%dS)&a 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 N)mkdtemp)escape) SystemMessage) EnvironmentFileSystemLoader)Sphinx)_get_module_data_pathget_module_source_path)encodingzspyder.utils.helpstaticZcssZjsZspyderZutilshelpZmathjaxZ MATHJAXPATH)relpathZ attr_nameZ JQUERYPATHcCsd|kpd|kS)z;Returns whether a string contains Sphinx-style ReST markup.`z::) docstringrr:lib/python3.7/site-packages/spyder/utils/help/sphinxify.pyis_sphinx_markupBsrcCs0t}tttd|_|d}|jt|dS)z-Print a warning message on the rich text view templatesz warning.html)css_pathtext) rrospjoin CONFDIR_PATHloader get_templaterenderCSS_PATH)messageenvwarningrrrr Hs r cCs6t}tttd|_|d}|jt||||dS)z+Print a usage message on the rich text viewrz usage.html)rtitleZ intro_messagetutorial_messagetutorial) rrrrrrrrr)r!rr"r#rusagerrrr$Ps   r$Fc CsT|rtjdkr|dd}|r"dnd|||||tttttjdkrDdndt j d }|S)aH 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.1) math_onnameargspecnotecollapseimg_pathrZjs_pathZ jquery_pathZ mathjax_pathright_sphinx_versionplatform) osr+replacerJS_PATH JQUERY_PATH MATHJAX_PATHsphinx __version__sysr1)r+r,r-Zmathr.r/contextrrrgenerate_contextYs   r;htmlc Cst}t|}t|d}t|d}|dkr6d}nd}t|d|}|drf|drf|d d }t|d }x d D]} || d | d}qxW||d <tj|ddd} | || d} | rt} t| } t | ntt d} d|i} t|d}t || |||| dddddd }y|d|gWn"tk rTtd}t|SXt|rtj|ddd}|dd}ntd}t|S| rtj| ddtj|dd|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` Z_buildz docstring.rstr<z.htmlz.txtrr0r*z\\z\\\\r,)=,()*z**z zwzutf-8)r Fzspyder.utils.helpZ html_contextZdoctreesNT)Zstatusr ZfreshenvZwarningiserrorZtagsz`It was not possible to generate rich text help for this object.
Please see it in plain text.rz
z
)
ignore_errors)rrZto_unicode_from_fsrrr3rcodecsopenwriteclosegenerate_configurationr
rZbuildrrr existsreadshutilZrmtree)rr:ZbuildernameZsrcdirZdestdirZrst_namesuffixZoutput_namer,charZdoc_fileZtemp_confdirZconfdirZ
confoverridesZ
doctreedirZ
sphinx_appoutputrrr	sphinxifysV





rPcCsttdd}tttdd}tt|dtt|dt||t|t|dtt|dd	dtt|dd	d	dd
S)z
    Generates a Sphinx configuration in `directory`.

    Parameters
    ----------
    directory : str
        Base directory to use
    zspyder.utils.helpzconf.pyrzlayout.htmlrz__init__.pyrBr%emptyN)
rrr
rr2makedirsrLcopyrFrG)Z	directoryZconfZlayoutrrrrIs
rI)r%r%r%FFr%)r<)&__doc__rEr2os.pathpathrrLr9ZtempfilerZxml.sax.saxutilsrZdocutils.utilsrZjinja2rrr7Zsphinx.applicationrZspyder.config.baserr	r
Zspyder.utilsrrrrr4r6r5rr r$r;rPrIrrrrs>		
7
]