File: //usr/lib/python3/dist-packages/sphinx/builders/html/__pycache__/__init__.cpython-310.pyc
o
�+�a� � @ s� d Z ddlZddlZddlZddlZddlZddlmZ ddlmZ ddlm Z m
Z
m Z m Z m
Z
mZmZmZmZ ddlmZ ddlmZ ddlmZ dd lmZ dd
lmZm Z dd l m Z dd l m Z dd
l!m"Z"m#Z# ddl!m$Z% ddl&m'Z' ddl(m)Z) ddl*m+Z+m,Z, ddl-m.Z.m/Z/m0Z0 ddl1m2Z2 ddl3m4Z4 ddl5m6Z6 ddl7m8Z8m9Z9 ddl:m;Z; ddl<m=Z=m>Z> ddl?m@Z@ ddlAmBZB ddlCmDZDmEZEmFZFmGZGmHZH dd lImJZJmKZK dd lLmMZM dd lNmOZO dd lPmQZQ dd lRmSZSmTZTmUZU dd!lVmWZWmXZXmYZYmZZZ dd"l[m\Z\ dd#l]m^Z^m_Z_ eJ� �r dd$l`maZa d%Zbnd&Zbd'ZceE�dee�Zfe�gd(�Zhd)e
d*eifd+d,�ZjG d-d.� d.ei�ZkG d/d0� d0ei�ZlG d1d2� d2�ZmG d3d4� d4e)�Znd5e'd6e,d*dfd7d8�Zod5e'd6e,d*dfd9d:�Zpd5e'd;eid<eid=e d>e d*df d?d@�Zqd5e'd;eid<eid=e d>e d*df dAdB�Zrd5e'd;eid<eid=e d>e d*df dCdD�Zsd5e'd*dfdEdF�Ztd5e'd6e,d*dfdGdH�Zud5e'd6e,d*dfdIdJ�Zvd5e'd6e,d*dfdKdL�Zwd5e'd6e,d*dfdMdN�ZxG dOdP� dP�Zyey� Zzd5e'd6e,d*dfdQdR�Z{ddl|Z!ddl}Z!d5e'd*e eie
f fdSdT�Z~dS )Uz�
sphinx.builders.html
~~~~~~~~~~~~~~~~~~~~
Several HTML builders.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� N)�datetime)�path) �IO�Any�Dict�Iterable�Iterator�List�Set�Tuple�Type)�quote)�nodes)�
publish_parts)� OptionParser)� DocTreeInput� StringOutput)�Node)�
relative_path)�__display_version__� package_dir)� version_info)�Sphinx)�Builder)�ENUM�Config)�Domain�Index�
IndexEntry)� ImageAdapter)� IndexEntries)�TocTree)� ConfigError�
ThemeError)�PygmentsBridge)�_�__)�js_index)�HTMLThemeFactory)�isurl�logging�md5�progress_message�status_iterator)�is_html5_writer_available� new_document)�
copy_asset)� format_date)�
InventoryFile)�DOTFILES�Matcher�patmatch)�copyfile� ensuredir�os_path� relative_uri)�Tags)�HTMLTranslator�
HTMLWriter)�HTML5TranslatorTFz objects.invz[
]+�obj�returnc C sN t | t�r
tt| �� ��S t | ttf�r tdd� | D ��} tt| �� � ��
� S )z�
Return a stable hash for a Python data structure. We can't just use
the md5 of str(obj) since for example dictionary items are enumerated
in unpredictable order due to hash randomization in newer Pythons.
c s s � | ]}t |�V qd S �N)�get_stable_hash)�.0�o� rD �?/usr/lib/python3/dist-packages/sphinx/builders/html/__init__.py� <genexpr>K � � z"get_stable_hash.<locals>.<genexpr>) �
isinstance�dictrA �list�items�tuple�sortedr+ �str�encode� hexdigest)r> rD rD rE rA B s
rA c @ sb e Zd ZU dZdZeeef ed< dZeed< dZ e
ed< dd�dedede
de d d f
d
d �Z dS ) �
Stylesheetz�A metadata of stylesheet.
To keep compatibility with old themes, an instance of stylesheet behaves as
its filename (str).
N�
attributes�filename�priority�� �rT �argsr? c O s^ t �| |�}||_||_||_|j�dd� |j�dd� |r-|d |jd< |d |jd< |S )N�rel�
stylesheet�typeztext/cssr � �title)rN �__new__rS rT rR �
setdefault)�clsrS rT rW rR �selfrD rD rE r] Z s zStylesheet.__new__)
�__name__�
__module__� __qualname__�__doc__rR r rN �__annotations__rS rT �intr r] rD rD rD rE rQ O s
�rQ c @ sZ e Zd ZU dZdZeeef ed< dZeed< dZ e
ed< d
dede
dedd fdd �Z dS ) �
JavaScriptz�A metadata of javascript file.
To keep compatibility with old themes, an instance of javascript behaves as
its filename (str).
NrR rS rT rU r? c K s" t �| |�}||_||_||_|S r@ )rN r] rS rT rR )r_ rS rT rR r` rD rD rE r] t s
zJavaScript.__new__)rU ) ra rb rc rd rR r rN re rS rT rf r] rD rD rD rE rg i s
rg c @ sp e Zd ZdZededd fdd��Zddg fdeded e e
ddfd
d �Z d d de fd
d�Z
deddfdd�ZdS )� BuildInfoz�buildinfo file manipulator.
HTMLBuilder and its family are storing their own envdata to ``.buildinfo``.
This class is a manipulator for the file.
�fr? c
C s� z<|� � }|d �� dksJ �|d �d�sJ �|d �d�s!J �t� }|d �� d �� |_|d �� d �� |_|W S tyQ } z t t
d�| �|�d }~ww ) Nr z # Sphinx build info version 1� zconfig: � ztags: r[ z build info file is broken: %r) � readlines�rstrip�
startswithrh �split�strip� config_hash� tags_hash� Exception�
ValueErrorr& )r_ ri �lines�
build_info�excrD rD rE �load� s ��zBuildInfo.loadN�config�tags�config_categoriesc C sH d| _ d| _|rdd� |�|�D �}t|�| _ |r"tt|��| _d S d S )N� c S s i | ]}|j |j�qS rD )�name�value)rB �crD rD rE �
<dictcomp>� s z&BuildInfo.__init__.<locals>.<dictcomp>)rq rr �filterrA rM )r` ry rz r{ �valuesrD rD rE �__init__� s
�zBuildInfo.__init__�otherc C s | j |j ko | j|jkS r@ )rq rr )r` r� rD rD rE �__eq__� s
�zBuildInfo.__eq__c C s |� d| j| jf � d S )Nz�# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: %s
tags: %s
)�writerq rr �r` ri rD rD rE �dump� s
�zBuildInfo.dump)ra rb rc rd � classmethodr rx r r: r rN r� �boolr� r� rD rD rD rE rh } s & rh c
s, e Zd ZU dZdZdZed�ZdZdZ dZ
dZ e Z
eed< dZdZg d�ZdZdZdZdZdZd ZdZd ZdZd
Z e ed < g Z e e e e!e" e e e e e# f e$f ed < d
e%dd
f� fdd� Z&d�dd�Z'de(fdd�Z)de fdd�Z*de fdd�Z+de e e,f fdd�Z-d�dd �Z.d�d d �Z/d�d d �Z0d!e d"edd
fd#d$�Z1d�d%d&�Z2d!e d"edd
fd'd(�Z3e4de!e5j6 fd)d*��Z7e4de fd+d,��Z8de9e fd-d.�Z:de e fd/d0�Z;d1e<de,e e f fd2d3�Z=d4e>e dd
fd5d6�Z?d7e d8e d9e de,e ef fd:d;�Z@d7e d<e5jAdd
fd=d>�ZBd7e d<e5jAdd
fd?d@�ZCd�dAdB�ZDeEedC��d�dDdE��ZFd�dFdG�ZGeEedH��d�dIdJ��ZHd�dKdL�ZId�dMdN�ZJd�dOdP�ZKd�dQdR�ZLd�dSdT�ZMd�dUdV�ZNd�dWdX�ZOdYe,dd
fdZd[�ZPdYe,dd
fd\d]�ZQd�d^d_�ZRd�d`da�ZSd�dbdc�ZTd�ddde�ZUd�dfdg�ZVd�dhdi�ZWd<e<dd
fdjdk�ZXd4eYe dd
fdldm�ZZdne d<e5jAdoe dd
fdpdq�Z[d�d7e dre$d"ede fdsdt�Z\dne de fdudv�Z]dne dwe,dd
fdxdy�Z^d�d7e dze de fd{d|�Z_ }
d�dne d~e,de d�e d�edd
f d�d��Z`dne de dwe,d�edd
f
d�d��Zad�d�d��ZbeEed���d�d�d���Zcd�d�d��Zd� ZeS )��StandaloneHTMLBuilderz&
Builds standalone HTML docs.
�htmlz!The HTML pages are in %(outdir)s.Tz.html�indexer_format)z
image/svg+xmlz image/pngz image/gifz
image/jpegzsearchindex.jsFN�imgpath�domain_indices�appr? c s t � �|� g | _g | _d S r@ )�superr� � css_files� script_files)r` r� �� __class__rD rE r� � s
z StandaloneHTMLBuilder.__init__c C s� | � � | _d| _i | _d | _| �� | �� | �� | �� | � dd�}|d ur+|| _
| � dd�}|d ur9|| _ n| j
| _ | � dd�| _ d S )N�_images� file_suffixr� � link_suffix� use_index)
�create_build_inforv �imagedir�
secnumbers�current_docname�init_templates�init_highlighter�init_css_files�
init_js_files�get_builder_config�
out_suffixr� r� )r` �html_file_suffix�html_link_suffixrD rD rE �init� s
zStandaloneHTMLBuilder.initc C s t | j| jdg�S )Nr� )rh ry rz �r` rD rD rE r� � s z'StandaloneHTMLBuilder.create_build_infoc sb � fdd�� j jD �t�td� j jdd�t�tjd� j jd�g }|D ] }t�|�r.| S q#d S )Nc s g | ] }t �|� jjd d��qS )� LC_MESSAGES� sphinx.js)r �joinry �language)rB �dirr� rD rE �
<listcomp>� s
��z>StandaloneHTMLBuilder._get_translations_js.<locals>.<listcomp>�localer� r� zshare/sphinx/locale) ry � locale_dirsr r� r r� �sys�prefix�isfile)r` �
candidates�jsfilerD r� rE �_get_translations_js� s
��
���
�z*StandaloneHTMLBuilder._get_translations_jsc C s, | j jd ur
| j jS | jr| j�dd�S dS )N�themerY z default.css)ry �
html_styler� �
get_configr� rD rD rE �_get_style_filename� s
z)StandaloneHTMLBuilder._get_style_filenamec C s | j j| j jfS r@ )ry �
html_theme�html_theme_optionsr� rD rD rE �get_theme_config � z&StandaloneHTMLBuilder.get_theme_configc C sH t | j�}| �� \}}|�|�| _|�� | _| �� | j� | | j� d S r@ )
r( r� r� �creater� �copy�
theme_options�create_template_bridge� templatesr� )r` �
theme_factory� themename� themeoptionsrD rD rE r� s
z$StandaloneHTMLBuilder.init_templatesc C s� | j jd ur | j j}n| jr| j�ddd�}nd}td|�| _| jr+| j�ddd �}nd }|d urBtd|�| _| jjddd d
� d S d | _d S ) Nr� �pygments_style�none�sphinxr� �pygments_dark_style�pygments_dark.cssz (prefers-color-scheme: dark)�pygments_dark_css)�media�id) ry r� r� r� r$ � highlighter�dark_highlighterr� � add_css_file)r` �style�
dark_stylerD rD rE r� s
�
z&StandaloneHTMLBuilder.init_highlighterc C s� g | _ | jddd� | j| �� dd� | jjj D ]
\}}| j|fi |�� q| �dd�D ]\}}|�dd� | j|fi |�� q,d S )N� pygments.css�� rV r� r� rT � )r� r� r� r� �registryr� r^ �r` rS �attrsrD rD rE r� ( s �z$StandaloneHTMLBuilder.init_css_filesrS �kwargsc K s0 d|vr
t �d|�}| j�t|fi |��� d S �N�://�_static)� posixpathr� r� �appendrQ �r` rS r� rD rD rE r� 4 s z"StandaloneHTMLBuilder.add_css_filec C s� g | _ | jddddd� | jddd� | jddd� | jd dd� | jjjD ]
\}}| j|fi |�� q&| �d
d �D ]\}}|�d d
� | j|fi |�� q:| jjr]| � � r_| �d� d S d S d S )Nzdocumentation_options.js�documentation_optionsr| r� )r� �
data_url_rootrT z jquery.jsrV z
underscore.jsz doctools.js�js_filesr� rT r� �translations.js)
r� � add_js_filer� r� r� r� r^ ry r� r� r� rD rD rE r� : s � �z#StandaloneHTMLBuilder.init_js_filesc K s4 |r d|vr t �d|�}| j�t|fi |��� d S r� )r� r� r� r� rg r� rD rD rE r� L s z!StandaloneHTMLBuilder.add_js_filec C s t r| jjrtS tS r@ )� html5_readyry � html4_writerr; r= r� rD rD rE �default_translator_classR s z.StandaloneHTMLBuilder.default_translator_classc C s\ | � dd�}|d ur |S t| jjj�}t|�dkr |d S t|�dkr,|�d� |d S d S )N�
math_rendererr� r[ r rj �mathjax)r� rJ r� r� �html_inline_math_renderers�len�remove)r` r} � renderersrD rD rE �math_renderer_nameY s
z(StandaloneHTMLBuilder.math_renderer_namec c s� � z4t t�| jd���
}t�|�}W d � n1 sw Y | j|kr4t�d� | j j
E d H W d S W n" t yO } zt� t
d�|� W Y d }~n
d }~w tyW Y nw | jra| j�� }nd}| j j
D ]b}|| j jvryt�d|� |V qg| �|�}zt�|�}W n ty� d}Y nw z/tt�| j �|��|�}||kr�t�d|t�|�t�|�|t�t�| j �|���� |V W qg ty� Y qgw d S )N�
.buildinfoz)[build target] did not match: build_info z"Failed to read build info file: %rr z![build target] did not in env: %rz>[build target] targetname %r(%s), template(%s), docname %r(%s))�openr r� �outdirrh rx rv �logger�debug�env�
found_docsrt �warningr& �OSErrorr� �newest_template_mtime�all_docs�get_outfilename�getmtimers �max�doc2pathr �utcfromtimestamp) r` �fp� buildinforw �template_mtime�docname�
targetname� targetmtime�srcmtimerD rD rE �get_outdated_docsm sb � �
� � �
���� ��z'StandaloneHTMLBuilder.get_outdated_docsc C s | j j| j j S r@ )ry �html_extra_path�html_static_pathr� rD rD rE �get_asset_paths� r� z%StandaloneHTMLBuilder.get_asset_paths�nodec C s@ |du rddiS t d�}|�|� t| �}td|tddi|d�S ) z$Utility: Render a lone doctree node.N�fragmentr| z<partial node>�doctree�output_encoding�unicode)� reader_name�writer� source_class�settings_overrides�source)r/ r� r< r r )r` r
�docr rD rD rE �render_partial� s
�z$StandaloneHTMLBuilder.render_partial�docnamesc C s& d | _ | jr*ddlm} | jjp| jj}|sd}|| j|| jj| jj �| _ | �
|� t | �| _ t
| jj| j fdd��� | _t| jj�| j_g | _| jj}|r�t| jj�D ]4}| jj| }|jD ](}d|j|jf }t|t�rs||vrsq_||�� � \} }
| r�| j� ||| |
f� q_qT| jj } | d ur�t | p�t d�| jjd�| _!nd | _!| jj"p�d } | jj#p�d }
t$| �s�t%�&| �} t$|
�s�t%�&|
�}
| j�'� | _(g }| j)r�|� d
t d �d t d
�f� | jD ]\}}} }
|j*r�|� ||j+d |j*f� q�t| j,�| _-t| j.�| _/i d| j0�d| jj1�dt2�3d | jj4��d| jj5�d| j!�d| jj6�d| jj7�d| jj7�d| jj8�d| jj9�d| jj:�d| jj;�d| jj<�d| jj=�d | jj>�d | jj?�d | j@�| jA| j,| jj| j.tBtC| �D� || jg | |
tE�on| jjF d �
�| _G| jH�r�| jG�Id d!� | jH�J| jK��L� D �� | jG�I| jjM� d S )"Nr )� IndexBuilder�enT)�defaults�
components�read_config_filesz%s-%sz %b %d, %Y)r� r| �genindexz
General Index�I�index�embedded�project�release�version� last_updated� copyright�
master_doc�root_doc�use_opensearch� docstitle�
shorttitle�show_copyright� show_sphinx�
has_source� show_source�sourcelink_suffixr� )
r� r� r� r� �sphinx_version�sphinx_version_tupler� �rellinks�builder�parents�logo�favicon�
html5_doctypec s s � | ] \}}d | |fV qdS )�theme_NrD )rB �key�valrD rD rE rF s �
�z8StandaloneHTMLBuilder.prepare_writing.<locals>.<genexpr>)N�indexer�search�
sphinx.searchr ry �html_search_languager� r� �html_search_options�html_search_scorer� load_indexerr< � docwriterr �settings�get_default_values� docsettingsr� �html_compact_lists�
compact_listsr� �html_domain_indicesrM �domains�indicesr} rH rJ �generater� �html_last_updated_fmtr1 r% r# � html_logo� html_faviconr) r �basename�collect_relations� relationsr� � shortname� localnamer� �
_script_filesr� �
_css_filesr r �return_codes_re�subr! r" r$ r& �html_use_opensearch�
html_title�html_short_title�html_show_copyright�html_show_sphinx�html_copy_source�html_show_sourcelink�html_sourcelink_suffixr� r� r r/ r� r� r� �
globalcontextr� �update� get_optionsr� rK � html_context)r` r r �lang�indices_config� domain_name�domain�indexcls� indexname�content�collapse�lufmtr4 r5 r1 rD rD rE �prepare_writing� s� �
��
���
�
�� �������� �
� � �
�����
� �z%StandaloneHTMLBuilder.prepare_writingr �body�metatagsc
C sT d }}g }| j d dd� }| j�|�}| jj} |rP|d rPz%| �||d �| �| |d �d d�}|�|d |d dtd�f� W n t yO d}Y nw |r�|d r�z%| �||d �| �| |d �d d�}|�|d |d d td
�f� W n t y� d}Y nw |r�|d r�z|�| �||d �| �| |d �d d�� W n t y� Y nw | j�|d �}|r�|d s�|r�|�
� |� � | jj �|�}
|
r�| �|
�d nd } | j�
|d
�t|�d� } | jjr�|| }
| | jjkr�|
| jj7 }
nd }
| jj�|�}t| j��|| �}| �|�d }|||| |||||
|| jj| dk| d� S )z1Collect items for the template context of a page.Nr1 rj r\ )�linkr\ �N�nextr[ �P�previousr r| Fr ) r3 �prevrq r\ �metarm rn r1 �
sourcename�toc� display_toc�page_source_suffix)r_ rP �getr� �titles�get_relative_urir r� r% �KeyError�pop�reverse�
longtitlesr� r� ry r\ r^ �metadatar! � get_toc_for�toc_num_entries)r` r rm rn rt rq r3 r1 �relatedr{ �
title_noder\ �
source_suffixrv ru �self_tocrw rD rD rE �get_doc_context s~ �" � �" � �� � � ��z%StandaloneHTMLBuilder.get_doc_contextr c C s� t dd�}| j|_| jj�|i �| _| jj�|i �| _t | �
|�d�| _ t | �
|�d�| _ || _
| j�||� | j�� | jjd }| jj}| �|||�}| j|||d� d S )N�utf-8��encodingr� �
_downloadsr )� event_arg)r rD rB r� �toc_secnumbersrz r� �toc_fignumbers�
fignumbersr9 �get_target_urir� �dlpathr� rA r� �assemble_parts�parts�
clean_metar� � handle_page)r` r r � destinationrm rn �ctxrD rD rE � write_doci s
z StandaloneHTMLBuilder.write_docc C sT t | �|�| j�| _| �|� | jj�|�}|r | �|�d nd}| � |||� d S )Nr\ r| )
r9 r� r� r� �post_process_imagesr� r� rz r �
index_page)r` r r r� r\ rD rD rE �write_doc_serializedz s
z*StandaloneHTMLBuilder.write_doc_serializedc C s| | j �| j� | j �| j� | j �| j� | j �| j� | j �| j� | j �| j� | j �| j� | j �| j � | �
� d S r@ ) � finish_tasks�add_task� gen_indices�gen_pages_from_extensions�gen_additional_pages�copy_image_files�copy_download_files�copy_static_files�copy_extra_files�write_buildinfo�
handle_finishr� rD rD rE �finish� s z StandaloneHTMLBuilder.finishzgenerating indicesc C s | j r| �� | �� d S r@ )r� �write_genindex�write_domain_indicesr� rD rD rE r� � s z!StandaloneHTMLBuilder.gen_indicesc C s4 | j �d�D ]}|D ] \}}}| �|||� q
qd S )N�html-collect-pages)�events�emitr� )r` �pagelist�pagename�context�templaterD rD rE r� � s
��z/StandaloneHTMLBuilder.gen_pages_from_extensionszwriting additional pagesc C s� | j j�� D ]\}}tj|d dd� | �|i |� q| jr,tjddd� | �di d� | j jrM| jrOtjddd� t� | j
dd �}| jd
i d |d � d S d S d S ) N� T��nonlzsearch r; z search.htmlz opensearch r� zopensearch.xml�
opensearch)� outfilename) ry �html_additional_pagesrK r� �infor� r; rW r r� r� )r` r� r� �fnrD rD rE r� � s �z*StandaloneHTMLBuilder.gen_additional_pagesc C s� t | j��| �}g }|D ]\}}|�tdd� |D ��� q ||| jjd�}tjddd� | jjr\| � d|d� | � d |d
� t
||�D ]\\}}}||||d �}| � d | |d
� qCd S | � d|d
� d S )Nc s s& � | ]\}\}}}d t |� V qdS )r[ N)r� )rB r% �subitemsrD rD rE rF � s � �z7StandaloneHTMLBuilder.write_genindex.<locals>.<genexpr>)�genindexentries�genindexcounts� split_indexz genindex Tr� r zgenindex-split.htmlz genindex-allz
genindex.html)r8 �entries�countr� z genindex-zgenindex-single.html) r r� � create_indexr� �sumry �html_split_indexr� r� r� �zip) r` r � indexcounts�_kr� �genindexcontextr8 r� r� rD rD rE r� � s6 ����� ��z$StandaloneHTMLBuilder.write_genindexc C sF | j D ] \}}}}|j||d�}tj|d dd� | �||d� qd S )N)�
indextitleri �collapse_indexr� Tr� zdomainindex.html)r� rR r� r� r� )r` rh rg ri rj � indexcontextrD rD rE r� � s ��z*StandaloneHTMLBuilder.write_domain_indicesc C s� | j rat| jj�j}tt�| j| j �� t
| j t d�dt | j �| jj
|d�D ]<}| j | }ztt�| j|�t�| j| j |�� W q& ty` } zt�t d�t�| j|�|� W Y d }~q&d }~ww d S d S )Nzcopying images... �brown��stringify_funcz cannot copy image file %r: %s)�imagesr r� r� �get_original_image_urir7 r r� r� r� r- r& r� � verbosityr6 �srcdirrs r� r� )r` r� �src�dest�errrD rD rE r� � s(
�
�
����z&StandaloneHTMLBuilder.copy_image_filesc s� dt dt f� fdd� }� jjrptt�� jd�� t� jjtd�dt � jj�� j
j |d�D ]E}z!t�� jd� jj| d �}tt� |�� t
t�� j|�|� W q, tyo } zt�td
�t�� j|�|� W Y d }~q,d }~ww d S d S ) Nri r? c s t � j| �S r@ )r r� )ri r� rD rE �
to_relpath� s z=StandaloneHTMLBuilder.copy_download_files.<locals>.to_relpathr� z copying downloadable files... r� r� r[ z$cannot copy downloadable file %r: %s)rN r� �dlfilesr7 r r� r� r- r& r� r� r� �dirnamer6 r� r� r� r� )r` r� r� r� r� rD r� rE r� � s&
�
����z)StandaloneHTMLBuilder.copy_download_filesc C s� t t�| jdd�d��}|�| j�� � W d � n1 s w Y | jrLt t�| jdd�d��}|�| j�� � W d � dS 1 sEw Y dS dS )z!create a style file for pygments.r� r� �wNr� )r� r r� r� r� r� �get_stylesheetr� r� rD rD rE �create_pygments_style_file� s �"��z0StandaloneHTMLBuilder.create_pygments_style_filec C s: | j jdur| �� }|rt|t�| jdd�� dS dS dS )z(Copy a JavaScript file for translations.Nr� r� )ry r� r� r6 r r� r� �r` r� rD rD rE �copy_translation_js s �z)StandaloneHTMLBuilder.copy_translation_jsc
C sv | j dur7t| j d�r#| j �� D ]}t|t�| jdt�|��� qdS | j �� }|r9t|t�| jdd�� dS dS dS )z#Copy a JavaScript file for stemmer.N�get_js_stemmer_rawcodesr� z _stemmer.js) r: �hasattrr� r6 r r� r� rN �get_js_stemmer_rawcoder� rD rD rE �copy_stemmer_js s
�
�z%StandaloneHTMLBuilder.copy_stemmer_jsr� c C sf dt dtdd fdd�}| jr/| j�� d d d� D ]}tt�|d�t�| jd�t|| j |d � qd S d S )
NrS �errorr? c S � t �td�| |� d S �Nz1Failed to copy a file in html_static_file: %s: %r�r� r� r& �rS r� rD rD rE �onerror �
�z>StandaloneHTMLBuilder.copy_theme_static_files.<locals>.onerror����staticr� )�excludedr� �rendererr� )
rN rs r� �get_theme_dirsr0 r r� r� r3 r� )r` r� r� �entryrD rD rE �copy_theme_static_files s ��z-StandaloneHTMLBuilder.copy_theme_static_filesc C sd dt dtdd fdd�}t| jjdg �}| jjD ]}tt�| j |�t�| j
d�||| j |d� qd S ) NrS r� r? c S r� r� r� r� rD rD rE r� r� z=StandaloneHTMLBuilder.copy_html_static_files.<locals>.onerrorz**/.*r� )r� r� r� ) rN rs r4 ry �exclude_patternsr r0 r r� �confdirr� r� )r` r� r� r� r� rD rD rE �copy_html_static_files s
��z,StandaloneHTMLBuilder.copy_html_static_filesc C �B | j jr t| j j�s tt�| j| j j�t�| jd�� d S d S d S �Nr� )ry rL r) r0 r r� r� r� r� rD rD rE �copy_html_logo) �
��z$StandaloneHTMLBuilder.copy_html_logoc C r� r� )ry rM r) r0 r r� r� r� r� rD rD rE �copy_html_favicon. r� z'StandaloneHTMLBuilder.copy_html_faviconc
C s� zTt td���C tt�| jd�� | j�� }| jd ur#|� | j�
� � | � � | � � | �
� | �|� | �|� | �� | �� W d � W d S 1 sMw Y W d S tyo } zt�td�|� W Y d }~d S d }~ww )Nzcopying static filesr� zcannot copy static file %r)r, r& r7 r r� r� r_ r� r: r` �context_for_searchtoolr� r� r� r� r� r� r� r� r� r� )r` r� r� rD rD rE r� 3 s$
&� ��z'StandaloneHTMLBuilder.copy_static_filesc
C s� z6t td���% t| jj�}| jjD ]}t�| j|�}t || j
|� qW d � W dS 1 s/w Y W dS t yQ } zt �
td�|� W Y d}~dS d}~ww )zcopy html_extra_path files.zcopying extra filesNzcannot copy extra file %r)r, r& r4 ry r� r r r� r� r0 r� r� r� r� )r` r� �
extra_pathr� r� rD rD rE r� G s �&� ��z&StandaloneHTMLBuilder.copy_extra_filesc
C s� z%t t�| jd�d��}| j�|� W d � W d S 1 s w Y W d S ty@ } zt�t d�|� W Y d }~d S d }~ww )Nr� r� z#Failed to write build info file: %r)
r� r r� r� rv r� r� r� r� r& )r` r� rw rD rD rE r� R s &� ��z%StandaloneHTMLBuilder.write_buildinfoc C s | j r
| j �� d S d S r@ )r� �cleanupr� rD rD rE r� Y s �z StandaloneHTMLBuilder.cleanupc s� t �| |� | jjr]| jr_|�tj�D ]M� t� fdd�dD ��s!qt� j tj
�r)qd� d v r0q� d }tj
dddd �}|| j v rNt �
| j| j | �|d
< n||d
< � �|� |�� � qd S d S d S ) zlPick the best candidate for an image and link down-scaled images to
their high res version.
c 3 � � | ]}|� v V qd S r@ rD )rB r8 �r
rD rE rF f rG z<StandaloneHTMLBuilder.post_process_images.<locals>.<genexpr>)�scale�width�heightzno-scaled-link�classes�urir| T)�internal�refuriN)r r� ry �html_scaled_image_link�traverser �image�anyrH �parent� referencer� r� r� r� � replace_selfr� )r` r r� r rD r� rE r� ^ s(
�
�z)StandaloneHTMLBuilder.post_process_imagesc C s� t | jj�t |� }zIt�| j| j�}| jr5t|dd��}| j �
|| j � W d � n1 s/w Y n t|d��}| j �
|| j � W d � n1 sMw Y W n t t
fyg |ret�td�� Y nw | j �|� d S )Nr� r� �rbzcsearch index couldn't be loaded, but not all documents will be built: the index will be incomplete.)�setr� r� r r� r� �searchindex_filename�indexer_dumps_unicoder� r: rx r� r� rt r� r� r& �prune)r` r �keep�
searchindexfn�ft�fbrD rD rE r@ { s$ �� ����z"StandaloneHTMLBuilder.load_indexerr� r\ c C sn | j d ur3|r5| jj|d d�}| jj�|i �}d|v r(| j �||dtd�� d S | j �||||� d S d S d S )N)�base�nosearchr| )r: r� r� r� rz �feedr/ )r` r� r r\ rS r� rD rD rE r� � s �z StandaloneHTMLBuilder.index_pagerj c K sN d|vrd|d< |� d�dkr|�d� | �t| j�j|| |fi |���d S )N�
includehiddenF�maxdepthr| r )rz r~ r r! r� �get_toctree_for)r` r rj r� rD rD rE �_get_local_toctree� s
���z(StandaloneHTMLBuilder._get_local_toctreec C s t �| jt|�| j �S r@ )r r� r� r8 r� )r` r� rD rD rE r� � s z%StandaloneHTMLBuilder.get_outfilenamer� c C s dt dtfdd�}d }d }d }| jjdkr9z| jj�dd�}|r*dd � |�d
�D �}W n! ty8 g d �}Y nw | j�ddd �}|rMd d � |�d
�D �}| � dd
�}|�
� D ]"\} }
t || �ry|ru|| �ru||�rtt �
td�||| � qW| }|
}qW|d u r ||d< ||d< d S )N�patternr? c s t � fdd�dD ��S )Nc 3 r� r@ rD )rB �char�r rD rE rF � rG zKStandaloneHTMLBuilder.add_sidebars.<locals>.has_wildcard.<locals>.<genexpr>z*?[)r r rD r rE � has_wildcard� s z8StandaloneHTMLBuilder.add_sidebars.<locals>.has_wildcard� alabasterr� �sidebarsc S � g | ]}|� � �qS rD �rp �rB r} rD rD rE r� � � z6StandaloneHTMLBuilder.add_sidebars.<locals>.<listcomp>�,)z
about.htmlznavigation.htmlzrelations.htmlzsearchbox.htmlz donate.htmlc S r rD r r! rD rD rE r� � r" r� z8page %s matches two patterns in html_sidebars: %r and %r�
customsidebar)rN r� r� r} ry rz ro rs r� r� rK r5 r� r� r& ) r` r� r� r r �matchedr$ �theme_default_sidebars�
html_sidebarsr � patsidebarsrD rD rE � add_sidebars� sB � �
�� z"StandaloneHTMLBuilder.add_sidebars�typc C s t |�| j S r@ )r
r� )r` r r* rD rD rE r� � s z$StandaloneHTMLBuilder.get_target_uri� page.html�addctx� templatenamer� r� c
s� �j �� }� |d< |d< �jj|d< ��� �}|�dd�d }�jjr2t��jj� �j �|d< nd |d< d|fd t
d
t d t
d t
f�fd
d�
}||d< dt
d t f�fdd� } | |d< � �fdd�|d< �� � |� |�
|� �j�jd d �< �j�jd d �< ��� |||� �j�d� |||�}
|
r�|
}ztt|d �dd� d�|d< W n ty� Y nw ztt|d �d d� d�|d< W n ty� Y nw z �j�||�} W n( ty� t� t d �� � Y d S t y� } z t t d �� | f �| �d } ~ ww |�s�� � �}t!t"�#|�� z"t$|d |d d d!��
}
|
�%| � W d � n 1 �s&w Y W n t&�yH } zt� t d"�||� W Y d }~nd }~ww �j'�rq|�(d#��rst"��j)d$t*|d# ��}t!t"�#|�� t+�j,�-� �|� d S d S d S )%Nr� �current_page_namer� �#r[ r �pageurlF�otheruri�resource�baseurir? c sB |rd| v r| S |s� � | �} t|| �pd}|dkr � js |}|S )Nr� r/ )r� r9 �allow_sharp_as_current_path)r1 r2 r3 r� r� rD rE �pathto� s
z1StandaloneHTMLBuilder.handle_page.<locals>.pathtor5 r} c s> | � j jv rdS | dkr� jrdS | dkr � �dd�r dS dS )NTr; r r� r� F)r� r� r; r� )r} r� rD rE �hasdoc� s z1StandaloneHTMLBuilder.handle_page.<locals>.hasdocr6 c s �j � fi | ��S r@ )r )r� �r� r` rD rE �<lambda> s z3StandaloneHTMLBuilder.handle_page.<locals>.<lambda>�toctree�html-page-contextr� c S � | j S r@ rV )�jsrD rD rE r8 � )r8 r� c S r; r@ rV )�cssrD rD rE r8 r= z�a Unicode error occurred when rendering the page %s. Please make sure all config values that contain non-ASCII content are Unicode strings.z6An error happened in rendering the page %s.
Reason: %rr� �xmlcharrefreplace)r� �errorszerror writing file %s: %srv �_sources).r_ r� ry �html_output_encodingr� �rsplit� html_baseurlr� r� r� rN r� r) r` rS r� rT r� �update_page_contextr� �emit_firstresultrM rJ �AttributeErrorr� �render� UnicodeErrorr� r� r& rs r# r� r7 r r� r� r� r� �
copysourcerz r� r8 r6 r� r� )r` r� r, r- r� r� r� �default_baseurir5 r6 �newtmpl�outputrw ri r� � source_namerD r7 rE r� � s�
�$
� � �
�����
� �� ��
��z!StandaloneHTMLBuilder.handle_pagec C s d S r@ rD )r` r� r- r� r� rD rD rE rE : s z)StandaloneHTMLBuilder.update_page_contextc C s& | j r
| j�| j� | j�| j� d S r@ )r: r� r� �dump_search_index�dump_inventoryr� rD rD rE r� > s z#StandaloneHTMLBuilder.handle_finishzdumping object inventoryc C s t �t�| jt�| j| � d S r@ )r2 r� r r� r� �INVENTORY_FILENAMEr� r� rD rD rE rP C s z$StandaloneHTMLBuilder.dump_inventoryc C s� t td�| j�� ��e | j�| jj� t�| j | j
�}| j rAt |d ddd��}| j�
|| j� W d � n1 s;w Y n t |d d��}| j�
|| j� W d � n1 s[w Y t�|d |� W d � d S 1 ssw Y d S )Nzdumping search index in %sz.tmpr� r� r� �wb)r, r& r: �labelr
r� r� r r� r� r r r� r� r� �os�replace)r` r r r rD rD rE rO G s �� �"�z'StandaloneHTMLBuilder.dump_search_index)r? N)Tr@ )r+ NN)fra rb rc rd r} �formatr& �epilogrJ �allow_parallelr� r� r' r� r re r r �supported_image_types�supported_remote_images�supported_data_uri_imagesr �add_permalinksr4 r r; r� �download_supportr� rN r� r r r r r r� r r� r� rh r� r� r� r r� r� r� r� r� r� r� �propertyr � NodeVisitorr� r� r r r r r r
rl r� �documentr� r� r� r, r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r@ r� r r� r) r� r� rE r� rP rO �
__classcell__rD rD r� rE r� � s�
0
."mP
4���
�
a��
�
r� r� ry c C �p g }|j D ]-}t|t�r|�|i f� qz
|\}}|�||f� W q ty2 t�td�|� Y qw ||_ dS )z?This converts string styled html_css_files to tuple styled one.z invalid css_file: %r, ignoredN)�html_css_filesrH rN r� rs r� r� r& )r� ry rc r� rS r� rD rD rE �convert_html_css_filesV �
�
rd c C rb )z>This converts string styled html_js_files to tuple styled one.z invalid js_file: %r, ignoredN)�
html_js_filesrH rN r� rs r� r� r& )r� ry rf r� rS r� rD rD rE �convert_html_js_filesg re rg r� r- r� r c �, |� d�� dtdtf� fdd� }||d< dS )zySet up css_tag() template helper.
.. note:: This set up function is added to keep compatibility with webhelper.
r5 r> r? c sf g }t | j�D ]}| j| }|d ur |�d|t�|d�f � q|�d� | jdd� � dd�|� S )N�%s="%s"Tz href="%s"�r2 z <link %s />r� )rM rR r� r� �escaperS r� )r> r� r8 r~ �r5 rD rE �css_tag� s
�z%setup_css_tag_helper.<locals>.css_tagrm N)rz rQ rN )r� r� r- r� r rm rD rl rE �setup_css_tag_helperx s
rn c rh )zxSet up js_tag() template helper.
.. note:: This set up function is added to keep compatibility with webhelper.
r5 r< r? c s� g }d}t | t�rNt| j�D ]/}| j| }|d ur=|dkr |}q|dkr0|�d� ddd� � q|�d|t�|d�f � q| jrM|�d� | jdd� � n |�d� | dd� � |rdd d
�|�|f S d | S ) Nr| rm r� zdata-url_root="%s"Trj ri zsrc="%s"z<script %s>%s</script>r� z<script>%s</script>) rH rg rM rR r� r� rk rS r� )r< r� rm r8 r~ rl rD rE �js_tag� s&
��z#setup_js_tag_helper.<locals>.js_tagro N)rz rg rN )r� r� r- r� r ro rD rl rE �setup_js_tag_helper� s
rp c C sx |� d�}|� d�}|rt|�s|d| dd�|d< n||d< |� d�}|r6t|�s6|d| dd�|d< d S ||d< d S )
z Set up relative resource paths.r5 r5 z_static/Trj � favicon_urlr4 �logo_urlN)rz r) )r� r� r- r� r r5 r5 r4 rD rD rE �setup_resource_paths� s
rs c C sL | j jdkrd S | j j}|d u rttd���|| jjvr$ttd�| ��d S )Nr� zEMany math_renderers are registered. But no math_renderer is selected.z"Unknown math_renderer %r is given.)r2 rV r� r" r& r� r� )r� r} rD rD rE �validate_math_renderer� s �rt c C � |j dd� D ]H}t�t�| j|��}t�|�s't�td�|� |j � |� qt�
| j �d t�
|�d krOt� | j |g�| j krOt�td�|� |j � |� qdS )z Check html_extra_paths setting.Nz'html_extra_path entry %r does not existr z0html_extra_path entry %r is placed inside outdir)
r r �normpathr� r� �existsr� r� r& r� �
splitdriver� �
commonpath)r� ry r� r� rD rD rE �validate_html_extra_path� �
��rz c C ru )z Check html_static_paths setting.Nz(html_static_path entry %r does not existr z1html_static_path entry %r is placed inside outdir)
r r rv r� r� rw r� r� r& r� rx r� ry )r� ry r� � static_pathrD rD rE �validate_html_static_path� r{ r} c C �N |j r!t�t�| j|j ��s#t|j �s%t�td�|j � d|_ dS dS dS dS )zCheck html_logo setting.zlogo file %r does not existN) rL r r� r� r� r) r� r� r& �r� ry rD rD rE �validate_html_logo� � ��
�r� c C r~ )zCheck html_favicon setting.z favicon file %r does not existN) rM r r� r� r� r) r� r� r& r rD rD rE �validate_html_favicon� r� r� c @ s e Zd Zdd� ZdS )�_stable_repr_objectc C s dS )Nz<object>rD r� rD rD rE �__repr__� s z _stable_repr_object.__repr__N)ra rb rc r� rD rD rD rE r� � s r� c C s> |j }|tu r dS t�td�� |sd|_dS t�|�|_dS )z0Migrate html_add_permalinks to html_permalinks*.Nzrhtml_add_permalinks has been deprecated since v3.5.0. Please use html_permalinks and html_permalinks_icon instead.F) �html_add_permalinks�UNSETr� r� r& �html_permalinksr� rk �html_permalinks_icon)r� ry r� rD rD rE �migrate_html_add_permalinks s
�r� c C sP | � t� | �ddd� | �dg d� | �di d� | �ddd� dtg� | �d d
d� d� | �d d dtg� | �d d dtg� | �d
d dtg� | �dg d� | �dg d� | �dg d� | �dg d� | �dd dtg� | �di d� | �di d� | �dddtg� | �dtd� | �ddd� | �ddd� | �ddd� | �d d d� | �d dd� | �d dd� | �d d!d� | �d"d#d� | �d$d dtg� | �d%d dtg� | �d&dd� | �d'dd� | �d(i d� | �d)d*d� | �d+dd� | �d,d-d� | �d.d dtg� | �d/i d� | �d0d#d � | �d1dd� | �d2d#d� | �d3d4dtd5d4�� | �d6d d7� | �d8d d� | �d9� | �d:� | jd;t d<d=� | jd;t
d<d=� | jd;t d<d=� | jd;t d<d=� | jd;t
d<d=� | jd;td<d=� | jd;td<d=� | �d>t� | �d:t� | �d:t� | �d:t� | �d?� | �d@� dAdddB�S )CNr� r r� �html_theme_pathr� rX c S s t d�| j| jf S )Nz%s %s documentation)r% r r! r� rD rD rE r8 # r" zsetup.<locals>.<lambda>rY c S r; r@ )rX r� rD rD rE r8 % r= r� rL rM rc rf r r rK r' r� rG Tr� r� r� � ¶�html_use_indexr� Fr\ r] r^ z.txtrW r| r� r� rZ r[ rb rB r� rE �html_secnumber_suffixz. r= r> r? r rD � html_codeblock_linenos_style�inline�table�html_math_rendererr� r� r� r: z
config-initedr� rV zbuilder-initedzsphinx.ext.mathjaxz sphinx.builders.html.transforms�builtin)r" �parallel_read_safe�parallel_write_safe)� add_builderr� �add_config_valuerN rJ r� r � add_event�connectrd rg r� rz r} r� r� rt rn rp rs �setup_extension)r� rD rD rE �setup s�
�
�
�r� )rd r� rT r� �rer� r r �typingr r r r r r r
r r � urllib.parser
�docutilsr �
docutils.corer �docutils.frontendr � docutils.ior r �docutils.nodesr �docutils.utilsr r� r r r r/ �sphinx.applicationr �sphinx.buildersr �
sphinx.configr r �sphinx.domainsr r r �!sphinx.environment.adapters.assetr �(sphinx.environment.adapters.indexentriesr �#sphinx.environment.adapters.toctreer! �
sphinx.errorsr" r# �sphinx.highlightingr$ �
sphinx.localer% r& r< r' �sphinx.themingr( � sphinx.utilr) r* r+ r, r- �sphinx.util.docutilsr. r/ �sphinx.util.fileutilr0 �sphinx.util.i18nr1 �sphinx.util.inventoryr2 �sphinx.util.matchingr3 r4 r5 �sphinx.util.osutilr6 r7 r8 r9 �sphinx.util.tagsr: �sphinx.writers.htmlr; r< �sphinx.writers.html5r= r� rQ � getLoggerra r� �compilerU rN rA rQ rg rh r� rd rg rn rp rs rt rz r} r� r� r� r� r� �sphinx.builders.dirhtml�sphinx.builders.singlehtmlr� rD rD rD rE �<module> s�
,
. 2��
���
�#��
�