3
T'íc/$ ã
@ s d Z ddlZddlmZ ddlmZmZmZmZmZm Z ddl
m Z ddl m
Z
ddlmZ ddlmZ dd lmZmZ dd
lmZ dd lmZ dd lmZ dd
lm Z ddl m Z ddl m Z m!Z! ddl"m#Z#m$Z$m%Z% ddl&m'Z' ddl(m)Z) ddl*m+Z+ ddl,m-Z- ddl.m/Z/m0Z0m1Z1 ddl2m3Z3m4Z4 e#j5e6Z7ejj8eddZ9G dd deZ:eeee;e;e;e;e;e;e;f dd d Z<eee;ef d d d Z=dS )!zTexinfo builder.é N)Úpath)ÚAnyÚDictÚIterableÚListÚTupleÚUnion)Únodes)Ú OptionParser)Ú
FileOutput)ÚNode)ÚaddnodesÚ package_dir)ÚSphinx)ÚBuilder)ÚConfig)Ú ImageAdapter)ÚNoUri)Ú_Ú__)ÚloggingÚprogress_messageÚstatus_iterator)Ú darkgreen)Ú new_document)Úcopy_asset_file)Úinline_all_toctrees)ÚSEPÚ ensuredirÚmake_filename_from_project)ÚTexinfoTranslatorÚ
TexinfoWriterZ templatesÚtexinfoc @ sú e Zd ZdZdZdZedZejdkr2eed7 ZdddgZ e
Z d d
d d Z e
eee f d
d
dZd$eeedddZd%eeeedddZd d
ddZed dddZeeee ejddd Zd d
d d Zed d d d!Zd d
d"d#Z d S )&ÚTexinfoBuilderz=
Builds Texinfo output to create Info documentation.
r" z$The Texinfo files are in %(outdir)s.Úposixzl
Run 'make' in that directory to run these through makeinfo
(use 'make info' here to do that automatically).z image/pngz
image/jpegz image/gifN)Úreturnc C s g | _ g | _d S )N)ÚdocnamesÚ
document_data)Úself© r) ú9/tmp/pip-build-gk9425m9/sphinx/sphinx/builders/texinfo.pyÚinit/ s zTexinfoBuilder.initc C s dS )Nz
all documentsr) )r( r) r) r* Úget_outdated_docs3 s z TexinfoBuilder.get_outdated_docs)ÚdocnameÚtypr% c C s" || j krt||nd| S d S )Nú%)r& r )r( r- r. r) r) r* Úget_target_uri6 s
z TexinfoBuilder.get_target_uri)Úfrom_Útor. r% c C s | j ||S )N)r0 )r( r1 r2 r. r) r) r* Úget_relative_uri< s z TexinfoBuilder.get_relative_uric C s dd | j jD }|s(tjtd d S g | _xl|D ]d}|d }|| jjkr^tjtd| q4| jj | |j
t d r|d d
}| jj ||d f q4W d S )
Nc S s g | ] }t |qS r) )Úlist)Ú.0Úxr) r) r* ú
<listcomp>A s z5TexinfoBuilder.init_document_data.<locals>.<listcomp>zGno "texinfo_documents" config value found; no documents will be writtenr z?"texinfo_documents" config value references unknown document %sÚindexé é éûÿÿÿ) ÚconfigÚtexinfo_documentsÚloggerÚwarningr ÚtitlesÚenvZall_docsr' ÚappendÚendswithr )r( Zpreliminary_document_dataÚentryr- r) r) r* Úinit_document_data@ s
z!TexinfoBuilder.init_document_data)Úignoredr% c G s | j xt| jD ]h}|d d
\}}}}|d7 }d } }} t|dkr^|dd
\}}} d}
t|dkrv|d }
ttj| j|dd} ttd | " | j j
p¨g } | j ||
| d
}
W d Q R X ttd ¦ | j |
t
| }t| jj|fd d
j }||_||_|d d
d |_| j j|_|p,d|_| p8d|_|pDd|_||_||
_|j|
| | j|d d
W d Q R X qW d S )Né z.texiÚ é é Fzutf-8)Zdestination_pathÚencodingz
processing %s)Ú
appendicesÚwritingT)ÚdefaultsÚ
componentsZread_config_filesr9 z.infor; r; ) rE r' Úlenr r ÚjoinÚoutdirr r r< Útexinfo_appendicesÚassemble_doctreeZpost_process_imagesr! r
rA ÚsettingsÚget_default_valuesÚauthorÚtitleZtexinfo_filenameÚtexinfo_elementsZtexinfo_dir_entryZtexinfo_dir_categoryZtexinfo_dir_descriptionr- ÚwriteÚcopy_image_files)r( rF rD r- Ú
targetnamerX rW ZdirentryÚ descriptionÚcategoryÚ toctree_onlyZ destinationrL ZdoctreeZ docwriterrU r) r) r* rZ S sD
zTexinfoBuilder.write)Ú indexfiler_ rL r% c C s t |g| | _tjt|d dd | jj|}||d< |rtd}tj }|tj
dd7 }||7 }x |j t j
D ] }||7 }qtW |}t| | j||t|g}||d< x*|D ]"} | jj| }
| |
d< |j|
q¬W tjd tjtd | jj||| x |j t jD ]} | d } | d
} tj| | g}
x`| jD ]V\}}| j|r2|
jtjtd td |
jtj|| |
jtjd d P q2W | j|
qW |S )
Nú T)Únonlr- z<texinfo output>z<Set title in conf.py>rH zresolving references...Z
refdocnameZ refsectnamez (in ú))Úsetr& r> Úinfor rA Z get_doctreer r ÚsectionrX Úfindallr
Ztoctreer rB r Zresolve_referencesZ pending_xrefZemphasisr@ Ú
startswithZTextr Z replace_self)r( r` r_ rL ÚtreeZnew_treeZnew_sectÚnodeZ largetreer- ZappendixZ pendingnodeÚsectnameZnewnodesÚsubdirrX r) r) r* rT x sF
z TexinfoBuilder.assemble_doctreec C s | j d S )N)Úcopy_support_files)r( r) r) r* Úfinish¢ s zTexinfoBuilder.finish)r\ r% c C sÊ | j rÆt| jjj}x°t| j tddt| j | jj|dD ]}| j | }y:t j
| j |d }t | t
t j
| j|t j
|| W q: tk
rÀ } z"tjtdt j
| j|| W Y d d }~X q:X q:W d S )Nzcopying images... Zbrown)Ústringify_funcz-figuresz cannot copy image file %r: %s)Zimagesr ÚapprA Zget_original_image_urir r rP Ú verbosityr rQ rR r r ÚsrcdirÚ Exceptionr> r? )r( r\ ro ÚsrcÚdestZimagedirÚerrr) r) r* r[ ¥ s
z TexinfoBuilder.copy_image_filesc C sx y@t td* tjddd ttjjtd| j W d Q R X W n2 t
k
rr } ztj td| W Y d d }~X nX d S )Nz copying Texinfo support filesz Makefile T)rb ÚMakefilez error writing file Makefile: %s) r r r> re r Úosr rQ Ú template_dirrR ÚOSErrorr? )r( rv r) r) r* rm µ s $z!TexinfoBuilder.copy_support_files)N)N) Ú__name__Ú
__module__Ú __qualname__Ú__doc__ÚnameÚformatr Úepilogrx Zsupported_image_typesr Zdefault_translator_classr+ r Ústrr r, r0 r3 rE r rZ Úboolr ÚdocumentrT rn r[ rm r) r) r) r* r# s&
%*r# )r< r% c C s$ t | j}| j|| j| j|ddfgS )z, Better default texinfo_documents settings. z One line description of projectZ
Miscellaneous)r ÚprojectZroot_docrW )r< Úfilenamer) r) r* Údefault_texinfo_documents¾ s
r )rp r% c C s| | j t | jdtd | jdg d | jdi d | jddd tg | jddd | jdd d | jd
dd d ddd S )
Nr= rS rY Ztexinfo_domain_indicesTZtexinfo_show_urlsZfootnoteZtexinfo_no_detailmenuFZtexinfo_cross_referencesÚbuiltin)ÚversionZparallel_read_safeZparallel_write_safe)Z add_builderr# Zadd_config_valuer r4 )rp r) r) r* ÚsetupÅ s
r )>r~ rx r Útypingr r r r r r Zdocutilsr Zdocutils.frontendr
Z docutils.ior Zdocutils.nodesr Zsphinxr
r Zsphinx.applicationr Zsphinx.buildersr Z
sphinx.configr Z!sphinx.environment.adapters.assetr Z
sphinx.errorsr Z
sphinx.localer r Z sphinx.utilr r r Zsphinx.util.consoler Zsphinx.util.docutilsr Zsphinx.util.fileutilr Zsphinx.util.nodesr Zsphinx.util.osutilr r r Zsphinx.writers.texinfor r! Ú getLoggerr{ r> rQ ry r# r r r r) r) r) r* Ú<module> s6
&