3
T'íc¥< ã @ sæ d Z ddlmZmZmZmZ ddlmZ ddlm Z m
Z
ddl m Z
ddl mZ ddlmZ ddlmZ dd lmZmZ dd
lmZ dd lmZ dd lmZ dd
l m Z ej e Z G dd deZ!G dd dZ"G dd dee
Z#dS )z5Manual page writer, extended for Sphinx custom nodes.é )ÚAnyÚDictÚIterableÚcast)Únodes)ÚElementÚ TextElement)Ú
Translator)ÚWriter)Úaddnodes)ÚBuilder)Ú_Úadmonitionlabels)Úlogging)ÚSphinxTranslator)Ú format_date)Ú NodeMatcherc s2 e Zd Zedd fdd ZddddZ ZS )ÚManualPageWriterN)ÚbuilderÚreturnc s t j || _d S )N)ÚsuperÚ__init__r )Úselfr )Ú __class__© ú8/tmp/pip-build-gk9425m9/sphinx/sphinx/writers/manpage.pyr s
zManualPageWriter.__init__)r c C sL t | j}|j | jj| j| j}tt|| _| jj| | jj | _
d S )N) ÚNestedInlineTransformÚdocumentÚapplyr Zcreate_translatorr ÚManualPageTranslatorÚvisitorÚ walkaboutÚastextÚoutput)r Z transformr r r r Ú translate s
zManualPageWriter.translate)Ú__name__Ú
__module__Ú __qualname__r r r$ Ú
__classcell__r r )r r r s r c @ s2 e Zd ZdZejddddZeddddZdS ) r a
Flatten nested inline nodes:
Before:
<strong>foo=<emphasis>1</emphasis>
&bar=<emphasis>2</emphasis></strong>
After:
<strong>foo=</strong><emphasis>var</emphasis>
<strong>&bar=</strong><emphasis>2</emphasis>
N)r r c C s
|| _ d S )N)r )r r r r r r . s z NestedInlineTransform.__init__)Úkwargsr c sÈ t tjtjtj x°t| jj D ]}t fdd|D r$|j j
|}x`t t|D ]P}|j | |r|j j
|d | qX|jdd|f|j}|j j
|d | qXW t|s$|j j | q$W d S )Nc 3 s | ]} |V qd S )Nr )Ú.0Úsubnode)Úmatcherr r ú <genexpr>4 s z.NestedInlineTransform.apply.<locals>.<genexpr>é Ú )r r ÚliteralZemphasisÚstrongÚlistr ÚfindallÚanyÚparentÚindexÚreversedÚremoveÚinsertr Ú
attributesÚlen)r r) ÚnodeÚposr+ Znewnoder )r, r r 1 s
zNestedInlineTransform.apply) r% r& r' Ú__doc__r r r r r r r r r r # s
r c sT e Zd ZU dZi Zeeef ej e
dd fdd Z edddZ e
dd d
d Ze
dd d d
Ze
dd ddZe
dd ddZe
dd ddZe
dd ddZe
dd ddZe
dd ddZe
dd ddZe
dd d d Ze
dd d d Ze
dd d d!Ze
dd d"d#Ze
dd d$d%Ze
dd d&d'Z e
dd d(d)Z e
dd d*d+Z e
dd d,d-Z e
dd d.d/Z e
dd d0d1Z!e
dd d2d3Z"e
dd d4d5Z#e
dd d6d7Z$e
dd d8d9Z%e
dd d:d;Z&e
dd d<d=Z'e
dd d>d?Z(e
dd d@dAZ)e
dd dBdCZ*e
dd dDdEZ+e
dd fdFdG Z,e
dd dHdIZ-e
dd fdJdK Z.e
dd dLdMZ/e
dd dNdOZ0e
dd dPdQZ1e
dd dRdSZ2e
dd dTdUZ3e
dd dVdWZ4e
dd dXdYZ5e
dd dZd[Z6e
dd d\d]Z7e
dd d^d_Z8e
dd d`daZ9e
dd dbdcZ:e
dd dddeZ;e
dd dfdgZ<e
dd dhdiZ=e
dd djdkZ>e
dd dldmZ?e
dd dndoZ@e
dd dpdqZAe
dd drdsZBe
dd dtduZCe
dd dvdwZDe
dd dxdyZEe
dd dzd{ZFe
dd d|d}ZGe
dd d~dZHe
dd ddZIe
dd ddZJe
dd dd
ZKe
dd ddZLe
dd ddZMe
dd ddZNe
dd ddZOe
dd ddZPe
dd fdd ZQe
dd fdd ZRe
dd fdd ZSe
dd fdd ZTe
dd ddZUe
dd ddZVe
dd ddZWe
dd ddZXe
dd d d¡ZYe
dd d¢d£ZZe
dd d¤d¥Z[e
dd d¦d§Z\ Z]S )¨r z%
Custom man page translator.
N)r r r c sþ t j|| d| _d| _| jj| jd< | jj| jd< | jjrL| jj| jd< | jj | jd< | jd j
| jd< | j j r| j j | jd< n"t
| j jptd | j jd
| jd< | j j| jd < | j j| jd < | j j| jd
< x&tj D ]\}}| j|| jj|< qÜW d S )Nr r. ÚtitleÚsubtitleÚauthorZmanual_sectionZ title_upperÚdatez %b %d, %Y)ÚlanguageÚ copyrightÚversionZ manual_groupéÿÿÿÿ)r r Úin_productionlistÚ
section_levelÚsettingsr? Ú_docinfor@ ZauthorsÚsectionÚupperÚconfigÚtodayr Z today_fmtr
rC rD rE Úprojectr ÚitemsÚ deunicodeÚlabels)r r r ÚlabelÚ translation)r r r r I s$ z ManualPageTranslator.__init__)r c C s d}| j d r|d7 }|| j S )NzW.TH "%(title_upper)s" "%(manual_section)s" "%(date)s" "%(version)s" "%(manual_group)s"
r@ z#.SH NAME
%(title)s \- %(subtitle)s
)rJ )r Útmplr r r Úheaderi s
zManualPageTranslator.header)r< r c C s d S )Nr )r r< r r r Úvisit_start_of_fileq s z(ManualPageTranslator.visit_start_of_filec C s d S )Nr )r r< r r r Údepart_start_of_filet s z)ManualPageTranslator.depart_start_of_filec C s | j | d S )N)Zvisit_definition_list)r r< r r r Ú
visit_desc~ s z ManualPageTranslator.visit_descc C s | j | d S )N)Zdepart_definition_list)r r< r r r Ú depart_desc s z ManualPageTranslator.depart_descc C s | j | | j| d S )N)Zvisit_definition_list_itemÚ
visit_term)r r< r r r Úvisit_desc_signature s
z)ManualPageTranslator.visit_desc_signaturec C s | j | d S )N)Z depart_term)r r< r r r Údepart_desc_signature s z*ManualPageTranslator.depart_desc_signaturec C s d S )Nr )r r< r r r Úvisit_desc_signature_line s z.ManualPageTranslator.visit_desc_signature_linec C s | j jd d S )Nú )ÚbodyÚappend)r r< r r r Údepart_desc_signature_line s z/ManualPageTranslator.depart_desc_signature_linec C s | j | d S )N)Zvisit_definition)r r< r r r Úvisit_desc_content s z'ManualPageTranslator.visit_desc_contentc C s | j | d S )N)Zdepart_definition)r r< r r r Údepart_desc_content s z(ManualPageTranslator.depart_desc_contentc C s d S )Nr )r r< r r r Úvisit_desc_inline s z&ManualPageTranslator.visit_desc_inlinec C s d S )Nr )r r< r r r Údepart_desc_inline s z'ManualPageTranslator.depart_desc_inlinec C s d S )Nr )r r< r r r Úvisit_desc_name s z$ManualPageTranslator.visit_desc_namec C s d S )Nr )r r< r r r Údepart_desc_name£ s z%ManualPageTranslator.depart_desc_namec C s d S )Nr )r r< r r r Úvisit_desc_addname¦ s z'ManualPageTranslator.visit_desc_addnamec C s d S )Nr )r r< r r r Údepart_desc_addname© s z(ManualPageTranslator.depart_desc_addnamec C s d S )Nr )r r< r r r Úvisit_desc_type¬ s z$ManualPageTranslator.visit_desc_typec C s d S )Nr )r r< r r r Údepart_desc_type¯ s z%ManualPageTranslator.depart_desc_typec C s | j jd d S )Nz -> )r` ra )r r< r r r Úvisit_desc_returns² s z'ManualPageTranslator.visit_desc_returnsc C s d S )Nr )r r< r r r Údepart_desc_returnsµ s z(ManualPageTranslator.depart_desc_returnsc C s | j jd d| _d S )Nú(r. )r` ra Ú first_param)r r< r r r Úvisit_desc_parameterlist¸ s z-ManualPageTranslator.visit_desc_parameterlistc C s | j jd d S )Nú))r` ra )r r< r r r Údepart_desc_parameterlist¼ s z.ManualPageTranslator.depart_desc_parameterlistc C s | j s| jjd nd| _ d S )Nz, r )rp r` ra )r r< r r r Úvisit_desc_parameter¿ s z)ManualPageTranslator.visit_desc_parameterc C s d S )Nr )r r< r r r Údepart_desc_parameterÅ s z*ManualPageTranslator.depart_desc_parameterc C s | j jd d S )Nú[)r` ra )r r< r r r Úvisit_desc_optionalÈ s z(ManualPageTranslator.visit_desc_optionalc C s | j jd d S )Nú])r` ra )r r< r r r Údepart_desc_optionalË s z)ManualPageTranslator.depart_desc_optionalc C s d S )Nr )r r< r r r Úvisit_desc_annotationÎ s z*ManualPageTranslator.visit_desc_annotationc C s d S )Nr )r r< r r r Údepart_desc_annotationÑ s z+ManualPageTranslator.depart_desc_annotationc C s | j | d S )N)Zvisit_paragraph)r r< r r r Úvisit_versionmodifiedÖ s z*ManualPageTranslator.visit_versionmodifiedc C s | j | d S )N)Zdepart_paragraph)r r< r r r Údepart_versionmodifiedÙ s z+ManualPageTranslator.depart_versionmodifiedc s. t |jtjr | jjd n t j| d S )NÚ
)r4 r3 r r1 r` ra r r[ )r r< )r r r r[ Ý s z ManualPageTranslator.visit_termc C s
t jd S )N)r ÚSkipNode)r r< r r r Ú
visit_commentä s z"ManualPageTranslator.visit_commentc s | j t j| d S )N)Ú
ensure_eolr Úvisit_footnote)r r< )r r r r è s z#ManualPageTranslator.visit_footnotec C sb | j t|dkrR|j dtdfkrR| jjd| j|j j d tj n | jjd d S )Nr. Z Footnotesz.SH r~ z.sp
)
r r; r" r
r` ra rQ rL r r )r r< r r r Ú visit_rubricí s
"z!ManualPageTranslator.visit_rubricc C s | j jd d S )Nr~ )r` ra )r r< r r r Ú
depart_rubricõ s z"ManualPageTranslator.depart_rubricc C s | j |d d S )NÚseealso)Zvisit_admonition)r r< r r r Ú
visit_seealsoø s z"ManualPageTranslator.visit_seealsoc C s | j | d S )N)Zdepart_admonition)r r< r r r Údepart_seealsoû s z#ManualPageTranslator.depart_seealsoc C s2 | j g }| jd7 _| jjd tttj |}x|D ]}|j|d q<W tdd |D }d }x¤|D ]}|d rÔ|d j |}| jj| j
d d | jj| j | | jj| j
d d | jjd n |d k rô| jjd d
t | |j
| | jjd qnW | jjd | jd8 _tjd S )
Nr. z.sp
.nf
Z tokennamec s s | ]}t |V qd S )N)r; )r* Únamer r r r- s z<ManualPageTranslator.visit_productionlist.<locals>.<genexpr>r1 r z ::= z%s r_ r~ z
.fi
)r rG r` ra r r r Ú
productionÚmaxÚljustÚdefsrQ r; r! r r )r r< ÚnamesZproductionlistr ÚmaxlenÚlastnamer r r Úvisit_productionlistþ s.
z)ManualPageTranslator.visit_productionlistc C s d S )Nr )r r< r r r Úvisit_production s z%ManualPageTranslator.visit_productionc C s d S )Nr )r r< r r r Údepart_production s z&ManualPageTranslator.depart_productionc C sD d|j kr&| jjtd|d d | jjtdd tjd S )NZaltz [image: %s]r~ z[image])r: r` ra r
r r )r r< r r r Ú visit_image s
z ManualPageTranslator.visit_imagec C sÈ | j j| jd d | j| | j j| jd d |jdd}|jdsj|jdsj|jdsj|jd r¾| jjr¾|j |kr¾|jdr|d
d
}| j j d | jd d || jd d d
g t
j d S )NÚ referencer r. Zrefurir/ zmailto:zhttp:zhttps:zftp:é z <r1 ú>) r` ra r Ú
visit_TextÚgetÚ
startswithrM Z
man_show_urlsr" Úextendr r )r r< Úurir r r Úvisit_reference% s
z$ManualPageTranslator.visit_referencec C s& t j|jdd}| j| t jd S )Nr? ú#)r ZTextr r r )r r< Útextr r r Úvisit_number_reference9 s
z+ManualPageTranslator.visit_number_referencec C s | j | jjd d S )Nz.sp
.ce
)r r` ra )r r< r r r Úvisit_centered> s z#ManualPageTranslator.visit_centeredc C s | j jd d S )Nz
.ce 0
)r` ra )r r< r r r Údepart_centeredB s z$ManualPageTranslator.depart_centeredc C s d S )Nr )r r< r r r Úvisit_compact_paragraphE s z,ManualPageTranslator.visit_compact_paragraphc C s d S )Nr )r r< r r r Údepart_compact_paragraphH s z-ManualPageTranslator.depart_compact_paragraphc C s d S )Nr )r r< r r r Úvisit_download_referenceK s z-ManualPageTranslator.visit_download_referencec C s d S )Nr )r r< r r r Údepart_download_referenceN s z.ManualPageTranslator.depart_download_referencec C s
t jd S )N)r r )r r< r r r Ú
visit_toctreeQ s z"ManualPageTranslator.visit_toctreec C s
t jd S )N)r r )r r< r r r Ú visit_indexT s z ManualPageTranslator.visit_indexc C s
t jd S )N)r r )r r< r r r Úvisit_tabular_col_specW s z+ManualPageTranslator.visit_tabular_col_specc C s d S )Nr )r r< r r r Úvisit_glossaryZ s z#ManualPageTranslator.visit_glossaryc C s d S )Nr )r r< r r r Údepart_glossary] s z$ManualPageTranslator.depart_glossaryc C s~ t tj|d }t ttj |}| j t tj|d }t ttj |}| jjdjdd |D d | jjd tj d S )Nr z, c s s | ]}|j V qd S )N)r" )r* Únr r r r- f s z2ManualPageTranslator.visit_acks.<locals>.<genexpr>Ú.r~ )
r r Ú bullet_listr Z list_itemr r` ra Újoinr )r r< r Z
list_itemsr r r Ú
visit_acks` s z ManualPageTranslator.visit_acksc C s | j | d S )N)Zvisit_bullet_list)r r< r r r Ú visit_hlistj s z ManualPageTranslator.visit_hlistc C s | j | d S )N)Zdepart_bullet_list)r r< r r r Ú depart_hlistm s z!ManualPageTranslator.depart_hlistc C s d S )Nr )r r< r r r Úvisit_hlistcolp s z#ManualPageTranslator.visit_hlistcolc C s d S )Nr )r r< r r r Údepart_hlistcols s z$ManualPageTranslator.depart_hlistcolc C s
| j |S )N)Zvisit_emphasis)r r< r r r Úvisit_literal_emphasisv s z+ManualPageTranslator.visit_literal_emphasisc C s
| j |S )N)Zdepart_emphasis)r r< r r r Údepart_literal_emphasisy s z,ManualPageTranslator.depart_literal_emphasisc C s
| j |S )N)Ú visit_strong)r r< r r r Úvisit_literal_strong| s z)ManualPageTranslator.visit_literal_strongc C s
| j |S )N)Ú
depart_strong)r r< r r r Údepart_literal_strong s z*ManualPageTranslator.depart_literal_strongc C s d S )Nr )r r< r r r Úvisit_abbreviation s z'ManualPageTranslator.visit_abbreviationc C s d S )Nr )r r< r r r Údepart_abbreviation
s z(ManualPageTranslator.depart_abbreviationc C s
| j |S )N)r¶ )r r< r r r Ú
visit_manpage s z"ManualPageTranslator.visit_manpagec C s
| j |S )N)r¸ )r r< r r r Údepart_manpage s z#ManualPageTranslator.depart_manpagec s8 t |jtjr(|jjdr(| jjd n t j| d S )NÚ
literal_blockz.sp
) Ú
isinstancer5 r Ú containerr r` ra r Ú
visit_caption)r r< )r r r rÁ s z"ManualPageTranslator.visit_captionc s8 t |jtjr(|jjdr(| jjd n t j| d S )Nr¾ r~ ) r¿ r5 r rÀ r r` ra r Údepart_caption)r r< )r r r r s z#ManualPageTranslator.depart_captionc sx t |jtjr | jjd d S t |jtjrl| jdkr>tj n.| jdkrl| jjd| j
|j j tj t
j|S )Nz.IP "r r. z.SH %s
)r¿ r5 r r
r` ra r rK rH r rQ r" rL r Ú visit_title)r r< )r r r rà s
z ManualPageTranslator.visit_titlec s* t |jtjr | jjd d S t j|S )Nz"
)r¿ r5 r r
r` ra r Ú depart_title)r r< )r r r rÄ ª s z!ManualPageTranslator.depart_titlec C s. d|j ddj kr$| jj|j tjd S )NZmanpageÚformatr/ )r Úsplitr` ra r" r r )r r< r r r Ú visit_raw° s z ManualPageTranslator.visit_rawc C s
t jd S )N)r r )r r< r r r Ú
visit_metaµ s z ManualPageTranslator.visit_metac C s d S )Nr )r r< r r r Ú visit_inline¸ s z!ManualPageTranslator.visit_inlinec C s d S )Nr )r r< r r r Ú
depart_inline» s z"ManualPageTranslator.depart_inlinec C s d S )Nr )r r< r r r Ú
visit_math¾ s z ManualPageTranslator.visit_mathc C s d S )Nr )r r< r r r Ú depart_mathÁ s z ManualPageTranslator.depart_mathc C s | j | d S )N)r )r r< r r r Úvisit_math_blockÄ s z%ManualPageTranslator.visit_math_blockc C s | j | d S )N)r¡ )r r< r r r Údepart_math_blockÇ s z&ManualPageTranslator.depart_math_block)^r% r& r' r> rJ r Ústrr r r r r rV r rW rX rY rZ r\ r] r^ rb rc rd re rf rg rh ri rj rk rl rm rn rq rs rt ru rw ry rz 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± 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 B s¦
r N)$r> Útypingr r r r Zdocutilsr Zdocutils.nodesr r Zdocutils.writers.manpager ZBaseTranslatorr
Zsphinxr Zsphinx.buildersr Z
sphinx.localer
r Z sphinx.utilr Zsphinx.util.docutilsr Zsphinx.util.i18nr Zsphinx.util.nodesr Ú getLoggerr% Úloggerr r r r r r r Ú<module> s