| Server IP : 127.0.0.1 / Your IP : 216.73.216.109 Web Server : Apache/2.4.54 (Win64) OpenSSL/1.1.1q PHP/8.1.10 System : Windows NT DESKTOP-E5T4RUN 10.0 build 19045 (Windows 10) AMD64 User : SERVERWEB ( 0) PHP Version : 8.1.10 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : OFF | Perl : OFF | Python : OFF | Sudo : OFF | Pkexec : OFF Directory : C:/cygwin64/lib/python3.9/site-packages/sphinx/ext/__pycache__/ |
Upload File : |
a
�ab � @ s� d Z ddlmZmZmZmZmZ ddlmZ ddl m
Z
m Z ddl m
Z
ddlmZ ddlZddlmZ dd lmZ dd
lmZ dd lmZ dd lmZ dd
lmZm Z ddl m Z m Z ddl m!Z!m"Z" ddl#m$Z$ ddl%m&Z& ddl'm(Z( e �)e*�Z+G dd� dej,ej
�Z-G dd� dej.ej
�Z/G dd� dee!�Z0G dd� de�Z1G dd � d e!�Z2G d d � d �Z3e&e-dd �d d!�Z4e&e-dd �d"d#�Z5e(e-dd �d$d%�Z6e(e-dd �d&d'�Z7eee8ef d(�d)d*�Z9dS )+a�
sphinx.ext.todo
~~~~~~~~~~~~~~~
Allow todos to be inserted into your documentation. Inclusion of todos can
be switched of by a configuration variable. The todolist directive collects
all todos of your project and lists them along with a backlink to the
original location.
:copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
� )�Any�Dict�List�Tuple�cast)�nodes)�Element�Node)�
directives)�BaseAdmonitionN)�addnodes)�Sphinx)�Domain)�BuildEnvironment)�NoUri)�_�__)�logging� texescape)�SphinxDirective� new_document)�
OptionSpec)�HTMLTranslator)�LaTeXTranslatorc @ s e Zd ZdS )� todo_nodeN��__name__�
__module__� __qualname__� r r �3/usr/lib/python3.9/site-packages/sphinx/ext/todo.pyr % s r c @ s e Zd ZdS )�todolistNr r r r r r! ) s r! c sV e Zd ZU dZeZdZdZdZdZ e
j e
j d�Z
eed< ee d�� fdd � Z� ZS )
�TodozO
A todo entry, displayed (if configured) in the form of an admonition.
Tr F)�class�name� option_spec��returnc s� | j �d�sdg| j d< t� �� \}t|tj�r6|gS t|t�r�|�dtj t
d�d�� | j j |d< | �
|� | �|� | jj�|� |gS t�d S )Nr# zadmonition-todor r" )�text�docname)�options�get�super�run�
isinstancer Zsystem_messager �insert�titler �envr) Zadd_nameZset_source_info�state�documentZnote_explicit_target� RuntimeError)�self�todo�� __class__r r r- < s
zTodo.run)r r r �__doc__r Z
node_class� has_content�required_arguments�optional_arguments�final_argument_whitespacer
Z class_optionZ unchangedr% r �__annotations__r r r- �
__classcell__r r r7 r r" - s
�r" c @ sn e Zd ZdZdZeeeee f d�dd��Z
edd�dd�Z ee edd �d
d �Z e
eejdd �d
d�ZdS )�
TodoDomainr6 r& c C s | j �di �S �N�todos)�data�
setdefault�r5 r r r rB R s zTodoDomain.todosN)r) r' c C s | j �|d � d S �N)rB �pop)r5 r) r r r � clear_docV s zTodoDomain.clear_doc)�docnames� otherdatar' c C s |D ]}|d | | j |< qd S rA )rB )r5 rI rJ r) r r r �merge_domaindataY s zTodoDomain.merge_domaindata)r1 r) r3 r' c C s^ | j �|g �}|�t�D ]@}|j�d|� |�|� |jjrt j
t d�|d � � |d� qd S )N� todo-definedzTODO entry found: %s� )�location)
rB rD �findallr �app�emit�append�config�todo_emit_warnings�loggerZwarningr �astext)r5 r1 r) r3 rB r6 r r r � process_doc] s
�zTodoDomain.process_doc)r r r r$ Zlabel�propertyr �strr r rB rH rK r r r3 rW r r r r r@ N s �r@ c @ s@ e Zd ZU dZdZdZdZdZi Ze e
d< e e d�dd�Z
dS ) �TodoListz%
A list of all todo entries.
Fr r% r& c C s
t d�gS )N� )r! rE r r r r- t s z TodoList.runN)r r r r9 r: r; r< r= r% r r> r r r- r r r r rZ i s
rZ c @ s\ e Zd Zeejedd�dd�Zejedd�dd�Ze eej
d�d d
�Z e edd�d d �Z dS )
�TodoListProcessorN)rP �doctreer) r' c C sF |j | _ |j| _|j| _tt|j�d��| _td�| _| � ||� d S )Nr6 r[ )
�builderrS r1 r r@ Z
get_domain�domainr r3 �process)r5 rP r] r) r r r �__init__{ s
zTodoListProcessor.__init__)r] r) r' c C s� t | jj�� g �}t|�t��D ]�}| jjs:|j �
|� q |� d�rPt �
� g}ng }|D ]D}|�� }|d �� | �||� |�|� | �||�}|�|� qX|�|� q d S )N�ids)�sumr_ rB �values�listrO r! rS �todo_include_todos�parent�remover+ r �targetZdeepcopy�clear�resolve_referencerR �create_todo_referenceZ replace_self) r5 r] r) rB �nodeZcontentr6 Znew_todoZtodo_refr r r r` � s
zTodoListProcessor.process)r6 r) r' c C s� | j jrtd�}ntd�|j|jf }|d |�d�� }||�d�d d � }tjdgd�}|t�||�7 }t� td�td��}tj
d d |d
d �}z6| j � ||d �|d
< |d
d|d d 7 < W n t
y� Y n0 ||7 }|t�||�7 }|S )Nz<<original entry>>z3(The <<original entry>> is located in %s, line %d.)z<<z>>� z todo-source)�classeszoriginal entryr[ T)Zinternalr) Zrefuri�#rb r )rS �todo_link_onlyr �source�line�findr � paragraph�TextZemphasis� referencer^ Zget_relative_urir ) r5 r6 r) � description�prefix�suffixZparaZlinktextrw r r r rl � s&
� z'TodoListProcessor.create_todo_referencec C sT |� tj�D ]}d|v r ||d< q | j|7 _| j�| j|| j� | j�|� dS )z'Resolve references in the todo content.ZrefdocN)rO r Z pending_xrefr3 r1 Zresolve_referencesr^ rh )r5 r6 r) rm r r r rk � s
z#TodoListProcessor.resolve_reference)
r r r r
r r3 rY ra r` r ru rl rk r r r r r\ z s r\ )r5 rm r' c C s | j jr| �|� ntj�d S rF )rS rf Zvisit_admonitionr �SkipNode�r5 rm r r r �visit_todo_node� s r} c C s | � |� d S rF )Zdepart_admonitionr| r r r �depart_todo_node� s r~ c C sp | j jrf| j�d� | j�| �|�� ttj|d �}t� |�
� | j j �}| j�d| � |� d� ntj
�d S )Nz
\begin{sphinxadmonition}{note}{r z%s:})rS rf �bodyrR Zhypertarget_tor r r0 r �escaperV Z latex_enginerG r{ )r5 rm Z
title_noder0 r r r �latex_visit_todo_node� s r� c C s | j �d� d S )Nz\end{sphinxadmonition}
)r rR r| r r r �latex_depart_todo_node� s r� )rP r' c C s� | � d� | �ddd� | �ddd� | �ddd� | �t� | jtttfttfttfttfttfd� | � dt
� | � d t � | � t
� | �d
t� tjd d d
�S )NrL rf F�htmlrq rT )r� Zlatexr( ZmanZtexinfor6 r! zdoctree-resolvedrn T)�versionZ env_versionZparallel_read_safe)Z add_eventZadd_config_valueZadd_noder! r r} r~ r� r� Z
add_directiver" rZ Z
add_domainr@ Zconnectr\ �sphinxZ__display_version__)rP r r r �setup� s(
�
�r� ):r9 �typingr r r r r Zdocutilsr Zdocutils.nodesr r Zdocutils.parsers.rstr
Z+docutils.parsers.rst.directives.admonitionsr r� r Zsphinx.applicationr
Zsphinx.domainsr Zsphinx.environmentr Z
sphinx.errorsr Z
sphinx.localer r Z sphinx.utilr r Zsphinx.util.docutilsr r Zsphinx.util.typingr Zsphinx.writers.htmlr Zsphinx.writers.latexr Z getLoggerr rU Z
Admonitionr ZGeneralr! r" r@ rZ r\ r} r~ r� r� rY r� r r r r �<module> s:
!K