File: //usr/lib/python3/dist-packages/sphinx/ext/__pycache__/todo.cpython-310.pyc
o
�$�a � @ 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 �Z3d e&d e-d!dfd"d#�Z4d e&d e-d!dfd$d%�Z5d e(d e-d!dfd&d'�Z6d e(d e-d!dfd(d)�Z7d*ed!ee8ef fd+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-2021 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 @ � e Zd ZdS )� todo_nodeN��__name__�
__module__� __qualname__� r r �1/usr/lib/python3/dist-packages/sphinx/ext/todo.pyr % � r c @ r )�todolistNr r r r r! r# ) r" r# c sV e Zd ZU dZeZdZdZdZdZ e
j e
j d�Z
eed< dee f� 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�s dg| j d< t� �� \}t|tj�r|gS t|t�rF|�dtj t
d�d�� | j j |d< | �
|� | �|� | jj�|� |gS t�)Nr% zadmonition-todor r$ )�text�docname)�options�get�super�run�
isinstancer �system_messager �insert�titler �envr* �add_name�set_source_info�state�document�note_explicit_target� RuntimeError)�self�todo�� __class__r r! r. < s
zTodo.run)r r r �__doc__r �
node_class� has_content�required_arguments�optional_arguments�final_argument_whitespacer
� class_option� unchangedr' r �__annotations__r r r. �
__classcell__r r r< r! r$ - s
� r$ c @ sz e Zd ZdZdZedeeee f fdd��Z
deddfdd�Z d ee d
eddfd d �Z d
e
dedejddfdd�ZdS )�
TodoDomainr; r( c C s | j �di �S �N�todos)�data�
setdefault�r: r r r! rJ R s zTodoDomain.todosr* Nc C s | j �|d � d S �N)rJ �pop)r: r* r r r! � clear_docV s zTodoDomain.clear_doc�docnames� otherdatac C s |D ] }|d | | j |< qd S rI )rJ )r: rQ rR r* r r r! �merge_domaindataY s �zTodoDomain.merge_domaindatar3 r7 c C s^ | j �|g �}|�t�D ] }|j�d|� |�|� |jjr,t j
t d�|d � � |d� q d S )N� todo-definedzTODO entry found: %s� )�location)
rJ rL �traverser �app�emit�append�config�todo_emit_warnings�logger�warningr �astext)r: r3 r* r7 rJ r; r r r! � process_doc] s
���zTodoDomain.process_doc)r r r r& �label�propertyr �strr r rJ rP rS r r r7 r` r r r r! rH N s
��rH c @ s@ e Zd ZU dZdZdZdZdZi Ze e
d< de e fdd�Z
dS ) �TodoListz%
A list of all todo entries.
Fr r' r( c C s
t d�gS )N� )r# rM r r r! r. t s
z TodoList.runN)r r r r> r@ rA rB rC r' r rF r r r. r r r r! rd i s
rd c @ sn e Zd Zdedejdeddfdd�Zdejdeddfdd �Zd
e dedej
fd d �Z d
e deddfd
d�Z dS )�TodoListProcessorrX �doctreer* r( Nc C sF |j | _ |j| _|j| _tt|j�d��| _td�| _| � ||� d S )Nr; re )
�builderr[ r3 r rH �
get_domain�domainr r7 �process)r: rX rg r* r r r! �__init__{ s
zTodoListProcessor.__init__c C s� t | jj�� g �}t|�t��D ]D}| jjs |j �
|� q|� d�r(t �
� g}ng }|D ]"}|�� }|d �� | �||� |�|� | �||�}|�|� q,|�|� qd S )N�ids)�sumrj rJ �values�listrW r# r[ �todo_include_todos�parent�remover, r �target�deepcopy�clear�resolve_referencerZ �create_todo_reference� replace_self) r: rg r* rJ �node�contentr; �new_todo�todo_refr r r! rk � s"
�zTodoListProcessor.processr; c C s� | j jr td�}n
td�|j|jf }|d |�d�� }||�d�d d � }tjdgd�}|t�||�7 }t� td�td��}tj
d d |d
d �}z| j � ||d �|d
< |d
d|d d 7 < W n t
ym Y nw ||7 }|t�||�7 }|S )Nz<<original entry>>z3(The <<original entry>> is located in %s, line %d.)z<<z>>� z todo-source)�classeszoriginal entryre T)�internalr* �refuri�#rm r )r[ �todo_link_onlyr �source�line�findr � paragraph�Text�emphasis� referencerh �get_relative_urir ) r: r; r* � description�prefix�suffix�para�linktextr� r r r! rx � 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.�refdocN)rW r � pending_xrefr7 r3 �resolve_referencesrh rs )r: r; r* rz r r r! rw � s �z#TodoListProcessor.resolve_reference)
r r r r
r r7 rc rl rk r r� rx rw r r r r! rf z s
rf r: rz r( c C s | j jr | �|� d S tj�rN )r[ rq �visit_admonitionr �SkipNode�r: rz r r r! �visit_todo_node� s r� c C s | � |� d S rN )�depart_admonitionr� r r r! �depart_todo_node� s r� c C sn | j jr4| j�d� | j�| �|�� ttj|d �}t� |�
� | j j �}| j�d| � |� d� d S tj
�)Nz
\begin{sphinxadmonition}{note}{r z%s:})r[ rq �bodyrZ �hypertarget_tor r r2 r �escaper_ � latex_enginerO r� )r: rz �
title_noder2 r r r! �latex_visit_todo_node� s r� c C s | j �d� d S )Nz\end{sphinxadmonition}
)r� rZ r� r r r! �latex_depart_todo_node� s r� rX c C s� | � d� | �ddd� | �ddd� | �ddd� | �t� | jtttfttfttfttfttfd� | � dt
� | � d t � | � t
� | �d
t� tjd d d
�S )NrT rq F�htmlr� r\ )r� �latexr) �man�texinfor; r# zdoctree-resolvedr~ T)�version� env_version�parallel_read_safe)� add_event�add_config_value�add_noder# r r� r� r� r� �
add_directiver$ rd �
add_domainrH �connectrf �sphinx�__display_version__)rX r r r! �setup� s(
�
�r� ):r> �typingr r r r r �docutilsr �docutils.nodesr r �docutils.parsers.rstr
�+docutils.parsers.rst.directives.admonitionsr r� r �sphinx.applicationr
�sphinx.domainsr �sphinx.environmentr �
sphinx.errorsr �
sphinx.localer r � sphinx.utilr r �sphinx.util.docutilsr r �sphinx.util.typingr �sphinx.writers.htmlr �sphinx.writers.latexr � getLoggerr r] �
Admonitionr �Generalr# r$ rH rd rf r� r� r� r� rc r� r r r r! �<module> s<
!K