3
T'íca ã @ 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 j)e*Z+G dd dej,ej
Z-G dd dej.ej
Z/G dd dee!Z0G dd deZ1G 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 )+zñ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.
é )Ú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 ú1/tmp/pip-build-gk9425m9/sphinx/sphinx/ext/todo.pyr s r c @ s e Zd ZdS )ÚtodolistN)r r r r r r r r # s r c sR e Zd ZU dZeZdZdZdZdZ e
j e
j dZ
e
ee d fdd Z ZS ) ÚTodozO
A todo entry, displayed (if configured) in the form of an admonition.
Tr F)ÚclassÚname)Úreturnc s | j jdsdg| j d< t j \}t|tjr6|gS t|tr|jdtj t
dd | j j |d< | j
| | j| | jjj| |gS td 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* 6 s
zTodo.run)r r r Ú__doc__r Z
node_classÚ has_contentÚrequired_argumentsÚoptional_argumentsÚfinal_argument_whitespacer
Z class_optionZ unchangedÚ option_specr r r r* Ú
__classcell__r r )r4 r r! ' s
r! c @ sn e Zd ZdZdZeeeee f dddZ
eddddZ ee edd d
d Z e
eejdd d
dZdS )Ú
TodoDomainr3 )r$ c C s | j jdi S )NÚtodos)ÚdataÚ
setdefault)r2 r r r r= L s zTodoDomain.todosN)r& r$ c C s | j j|d d S )N)r= Úpop)r2 r& r r r Ú clear_docP s zTodoDomain.clear_doc)ÚdocnamesÚ otherdatar$ c C s$ x |D ]}|d | | j |< qW d S )Nr= )r= )r2 rB rC r& r r r Úmerge_domaindataS s
zTodoDomain.merge_domaindata)r. r& r0 r$ c C sb | j j|g }xN|jtD ]@}|jjd| |j| |jjrt j
t d|d j |d qW d S )Nz todo-definedzTODO entry found: %sé )Úlocation)
r= r? Úfindallr ÚappÚemitÚappendÚconfigÚtodo_emit_warningsÚloggerÚwarningr Úastext)r2 r. r& r0 r= r3 r r r Ú process_docW s
zTodoDomain.process_doc)r r r r# ÚlabelÚpropertyr Ústrr r r= rA rD r r r0 rP r r r r r< H s r< c @ s< e Zd ZU dZdZdZdZdZi Ze e
e dddZ dS )ÚTodoListz%
A list of all todo entries.
Fr )r$ c C s
t dgS )NÚ )r )r2 r r r r* n s z TodoList.runN)
r r r r5 r6 r7 r8 r9 r: r r r r* r r r r rT c s
rT c @ s\ e Zd ZeejeddddZejeddddZe eej
dd d
Z e eddd d Z dS )
ÚTodoListProcessorN)rH Údoctreer& r$ c C sF |j | _ |j| _|j| _tt|jjd| _td| _| j || d S )Nr3 rU )
ÚbuilderrK r. r r< Z
get_domainÚdomainr r0 Úprocess)r2 rH rW r& r r r Ú__init__u s
zTodoListProcessor.__init__)rW r& r$ c C s¶ t | jjj g }xt|jtD ]}| jjs<|j j
| q"|j drRt j
g}ng }xL|D ]D}|j }|d j | j|| |j| | j||}|j| q\W |j| q"W d S )NÚids)ÚsumrY r= ÚvaluesÚlistrG r rK Útodo_include_todosÚparentÚremover( r ÚtargetÚdeepcopyÚclearÚresolve_referencerJ Úcreate_todo_referenceZ replace_self) r2 rW r& r= ÚnodeÚcontentr3 Znew_todoZtodo_refr r r rZ ~ s
zTodoListProcessor.process)r3 r& r$ c C sú | j jrtd}ntd|j|jf }|d |jd
}||jdd d
}tjdgd}|tj||7 }tj tdtd}tj
d d |d
d }y6| j j ||d |d
< |d
d|d d 7 < W n t
k
rÜ Y nX ||7 }|tj||7 }|S )Nz<<original entry>>z3(The <<original entry>> is located in %s, line %d.)z<<z>>é z todo-source)Úclasseszoriginal entryrU T)Zinternalr& Zrefuriú#r\ r )rK Útodo_link_onlyr ÚsourceÚlineÚfindr Ú paragraphZTextZemphasisÚ referencerX Zget_relative_urir ) r2 r3 r& Ú descriptionÚprefixÚsuffixÚparaZlinktextrr r r r rg s$
z'TodoListProcessor.create_todo_referencec C sX x$|j tjD ]}d|kr||d< qW | j|7 _| jj| j|| j | jj| dS )z'Resolve references in the todo content.ZrefdocN)rG r Z pending_xrefr0 r. Zresolve_referencesrX rb )r2 r3 r& rh r r r rf ³ s z#TodoListProcessor.resolve_reference)
r r r r
r r0 rS r[ rZ r rq rg rf r r r r rV t s rV )r2 rh r$ c C s | j jr| j| ntjd S )N)rK r` Zvisit_admonitionr ÚSkipNode)r2 rh r r r Úvisit_todo_node¿ s rx c C s | j | d S )N)Zdepart_admonition)r2 rh r r r Údepart_todo_nodeÆ s ry c C sp | j jrf| jjd | jj| j| ttj|d }tj |j
| j j }| jjd| |j d ntj
d S )Nz
\begin{sphinxadmonition}{note}{r z%s:})rK r` ÚbodyrJ Zhypertarget_tor r r- r ÚescaperO Z latex_enginer@ rw )r2 rh Z
title_noder- r r r Úlatex_visit_todo_nodeÊ s r| c C s | j jd d S )Nz\end{sphinxadmonition}
)rz rJ )r2 rh r r r Úlatex_depart_todo_node× s r} )rH r$ c C s¤ | j d | jddd | jddd | jddd | jt | jtttfttfttfttfttfd | j dt
| j d t | j t
| jd
t tjd d d
S )Nz todo-definedr` FÚhtmlrm rL )r~ Zlatexr% ZmanZtexinfor3 r zdoctree-resolvedrj T)ÚversionZ env_versionZparallel_read_safe)Z add_eventZadd_config_valueÚadd_noder r rx ry r| r} Z
add_directiver! rT Z
add_domainr< ÚconnectrV ÚsphinxZ__display_version__)rH r r r ÚsetupÛ s$
r ):r5 Ú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 Ú getLoggerr rM Z
Admonitionr ZGeneralr r! r< rT rV rx ry r| r} rS r r r r r Ú<module> s:
!K