U YSh /@sdZddlZddlZddlmZddlmZmZmZmZm Z m Z ddl m Z ddl mZmZmZddlZddlmZddlmZdd lmZdd lmZdd lmZdd lmZdd lmZddlm Z ddl!m"Z"ddl#m$Z$m%Z%ddl&m'Z'ddl(m)Z)ej*dddkrddl+m,Z,n ddlm,Z,dZ-dZ.e/e0Z1ee0dZ2e3e4e5Z6e7e6dZ8ddddddd d!d"d#d$d%d&d'd(d)d*d+d,d-d.d/d0d1d2d3d4d5d6d7Z9dFe:e;e:d9d:d;ZGd>d?d?eZ?ee:d@dAdBZ@eee:efdCdDdEZAdS)Gz sphinxcontrib.htmlhelp ~~~~~~~~~~~~~~~~~~~~~~ Build HTML help support files. :copyright: Copyright 2007-2019 by the Sphinx team, see README. :license: BSD, see LICENSE for details. N)path)AnyDictListSetTupleType)nodes)ElementNodedocument)addnodes)Sphinx)StandaloneHTMLBuilder)Config) IndexEntries)get_translation)logging)copy_asset_file) NodeMatcher)make_filename_from_projectrelpath)SphinxRendererHTMLTranslator))progress_messagez2.0.1)rrrconsoleZ templates)icp1252)icp1250)ir )ir ) r )i r )i%cp1257)i)cp1256)i r )i r )ir!)ir!)ir )icp932)icp949)i'r#)i&r#)ir )ir )ir!)ir )iz windows-1251)ir!)i$r!)ir )icp1254)i"cp1251)icp936)icp950)cacsdadeenesetfafifrhrhuitjakoltlvnlZno_NBplpt_BRruskslsvtruk_UAzh_CNzh_TWT)squotereturncCst||}|dd}|S)a5 chm_htmlescape() is a wrapper of html.escape(). .hhc/.hhk files don't recognize hex escaping, we need convert hex escaping to decimal escaping. for example: ``'`` -> ``'`` html.escape() may generates a hex escaping ``'`` for single quote ``'``, this wrapper fixes this. z'z')htmlescapereplace)rGrHrMR/root/rtd-docs/venv/lib/python3.8/site-packages/sphinxcontrib/htmlhelp/__init__.pychm_htmlescapeUs  rOcseZdZeddfdd ZeddddZedd d Zedd d d Z edd ddZ e dd ddZ e dd ddZ e dd ddZe dd ddZe dd ddZZS)ToCTreeVisitorN)r rIcst|g|_d|_dS)Nr)super__init__bodydepth)selfr  __class__rMrNrRcs zToCTreeVisitor.__init__)textrIcCs|j|dSN)rSappend)rUrXrMrMrNrZhszToCTreeVisitor.appendrIcCs d|jS)N )joinrSrUrMrMrNastextkszToCTreeVisitor.astext)noderIcCsdSrYrMrUr`rMrMrN unknown_visitnszToCTreeVisitor.unknown_visitcCsdSrYrMrarMrMrNunknown_departureqsz ToCTreeVisitor.unknown_departurecCs&|jdkr|d|jd7_dS)NrzrdrarMrMrNdepart_bullet_listzs z!ToCTreeVisitor.depart_bullet_listcCs|d|jd7_dS)Nz!
  • r)rZrTrarMrMrNvisit_list_items zToCTreeVisitor.visit_list_itemcCs|jd8_dS)Nr)rTrarMrMrNdepart_list_itemszToCTreeVisitor.depart_list_itemcCsBt|d}|d||d|d|dtjdS)NTz" z# refuriz )rOr_rZr ZSkipNode)rUr`titlerMrMrNvisit_references  zToCTreeVisitor.visit_reference)__name__ __module__ __qualname__r rRstrrZr_r rbrcr rergrhrirl __classcell__rMrMrVrNrPbsrPcs*eZdZdZdZedZdZdddgZdZ dZ dZ d Z d Z d d fd d Zedd ddZeed dfdd Zeeeed dddZd d ddZeed dfdd ZeeedddZeed d d d!d"Zeed#d d d$d%Zeed&d d d'd(Zeed d)d*d+ZZS),HTMLHelpBuilderz Builder that also outputs Windows HTML help project, contents and index files. Adapted from the original Doc/tools/prechm.py. ZhtmlhelpzDYou can now run HTML Help Workshop with the .htp file in %(outdir)s.Fz image/pngz image/gifz image/jpegTr"r Nr[cs<d|_d|_tt|jj}|dk r8|\|_|_ dS)N.html) out_suffixZ link_suffixrQinit chm_localesgetconfiglanguagelcidencoding)rUlocalerVrMrNrus  zHTMLHelpBuilder.initzType[nodes.NodeVisitor]cCstSrYrr^rMrMrNdefault_translator_classsz(HTMLHelpBuilder.default_translator_class)docnamesrIcst|d|jd<dS)NFZ html5_doctype)rQprepare_writingZ globalcontext)rUr~rVrMrNrs zHTMLHelpBuilder.prepare_writing)pagename templatenamectx event_argrIcCs|j|d<dS)Nr{)r{)rUrrrrrMrMrNupdate_page_contextsz#HTMLHelpBuilder.update_page_contextcCs.|||||j|jjdSrY)copy_stopword_listbuild_project_filebuild_toc_file build_hhxoutdirrxhtmlhelp_basenamer^rMrMrN handle_finishszHTMLHelpBuilder.handle_finish)docnamedoctreerIcsB|tjD]"}|ddkr d|kr d|d<q t||dS)NZinternalrjZ_blanktarget)traverser referencerwrQ write_doc)rUrrr`rVrMrNrs zHTMLHelpBuilder.write_doc)namecontextrIcCstt}|||SrY)r template_dirrender)rUrrtemplaterMrMrNrszHTMLHelpBuilder.renderzcopying stopword listcCs0ttd}t|j|jjd}t||dS)aCopy a stopword list (.stp) to outdir. The stopword list contains a list of words the full text search facility shouldn't index. Note that this list must be pretty small. Different versions of the MS docs claim the file has a maximum size of 256 or 512 bytes (including at the end of each line). Note that "and", "or", "not" and "near" are operators in the search language, so no point indexing them even if we wanted to. z project.stpz.stpN)rr]rrrxrr)rUrfilenamerMrMrNrs z"HTMLHelpBuilder.copy_stopword_listzwriting project filec Cs g}t|jD]|\}}}|||t|jd}t|D]D}|rX|drb|drFt t|||j}| | tj dqFqt|j|j jd}t|d|jddL}|j j|j j|j j|j j|j|j j|j|d } |d | } || W5QRXd S) z'Create a project file (.hhp) on outdir.Z_staticz.jsrs\z.hhpwxmlcharrefreplacer{errors)outnamerkversionprojectrz master_docfilesz project.hhpN)oswalkrsort startswithrr]sortedendswithrrZrLseprxropenr{Z html_titlerrrzrrtrwrite) rUZ project_filesrootdirsrZ in_staticdirfnrfrrSrMrMrNrs*   z"HTMLHelpBuilder.build_project_filezwriting TOC filec Cst|j|jjd}t|d|jdd~}|jj|jj |dd}t |}t t j dd}||D]}||q`||j|jj|jj |jd }||d |W5QRXd S) z#Create a ToC file (.hhp) on outdir.z.hhcrrrF)Zprune_toctreesT)toctree)rSsuffixZ short_titlerdomain_indicesz project.hhcN)rr]rrxrrr{envZget_and_resolve_doctreerrPrr Zcompact_paragraphrZ walkaboutr_rtZhtml_short_titlerrr)rUrrrvisitorZmatcherr`rrMrMrNrs  zHTMLHelpBuilder.build_toc_file)rrrIc sttdt|j|}t||d}t|d|j dd dt t t t t ft t t t t t t ffddfdd |D](\}}|D]\}\}} } ||| qq d W5QRXdS) Nzwriting index file...z.hhkrrrz