B
d< @ 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 e e Z G dd deZ!G dd dZ"G dd dee
Z#dS )z5Manual page writer, extended for Sphinx custom nodes. )AnyDictIterablecast)nodes)Element TextElement)
Translator)Writer)addnodes)Builder)_admonitionlabels)logging)SphinxTranslator) format_date) NodeMatcherc s2 e Zd Zedd fdd ZddddZ ZS )ManualPageWriterN)builderreturnc s t || _d S )N)super__init__r )selfr ) __class__ c/work/yifan.wang/ringdown/master-ringdown-env/lib/python3.7/site-packages/sphinx/writers/manpage.pyr s
zManualPageWriter.__init__)r c C sL t | j}| | j| j| j}tt|| _| j| | j | _
d S )N) NestedInlineTransformdocumentapplyr Zcreate_translatorr ManualPageTranslatorvisitor walkaboutastextoutput)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:
foo=1
&bar=2
After:
foo=var
&bar=2
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 xt| j D ]}t fdd|D r$|j
|}x`t t|D ]P}| | |r|j
|d | qX|jdd|f|j}|j
|d | qXW t|s$|j | q$W d S )Nc 3 s | ]} |V qd S )Nr ).0subnode)matcherr r 4 s z.NestedInlineTransform.apply.. )r r literalZemphasisstronglistr findallanyparentindexreversedremoveinsertr
attributeslen)r r) nodeposr+ 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 sX e Zd ZU dZi Zeeef ed< e j
e dd fdd Z eddd Z
edd
d d Zedd
d
dZedd
ddZedd
ddZedd
ddZedd
ddZedd
ddZedd
ddZedd
dd Zedd
d d Zedd
d d Zedd
d!d"Zedd
d#d$Zedd
d%d&Z edd
d'd(Z edd
d)d*Z edd
d+d,Z edd
d-d.Z edd
d/d0Z!edd
d1d2Z"edd
d3d4Z#edd
d5d6Z$edd
d7d8Z%edd
d9d:Z&edd
d;d<Z'edd
d=d>Z(edd
d?d@Z)edd
dAdBZ*edd
dCdDZ+edd
dEdFZ,edd
fdGdH Z-edd
dIdJZ.edd
fdKdL Z/edd
dMdNZ0edd
dOdPZ1edd
dQdRZ2edd
dSdTZ3edd
dUdVZ4edd
dWdXZ5edd
dYdZZ6edd
d[d\Z7edd
d]d^Z8edd
d_d`Z9edd
dadbZ:edd
dcddZ;edd
dedfZedd
dkdlZ?edd
dmdnZ@edd
dodpZAedd
dqdrZBedd
dsdtZCedd
dudvZDedd
dwdxZEedd
dydzZFedd
d{d|ZGedd
d}d~ZHedd
ddZIedd
ddZJedd
ddZKedd
ddZLedd
ddZMedd
ddZNedd
ddZOedd
ddZPedd
ddZQedd
fdd ZRedd
fdd ZSedd
fdd ZTedd
fdd ZUedd
ddZVedd
ddZWedd
ddZXedd
ddZYedd
ddZZedd
ddZ[edd
ddZ\edd
ddZ] Z^S )r z%
Custom man page translator.
_docinfoN)r r r c s t || d| _d| _| jj| jd< | jj| jd< | jjrL| jj| jd< | jj | jd< | jd
| jd< | j j r| j j | jd< n"t
| j jptd | j jd
| jd< | j j| jd < | j j| jd < | j j| jd
< x&t D ]\}}| || jj|< qW d S )Nr titlesubtitleauthorZmanual_sectionZ title_upperdatez %b %d, %Y)language copyrightversionZ manual_group)r r in_productionlist
section_levelsettingsrA r? rB Zauthorssectionupperconfigtodayr Z today_fmtr
rE rF rG projectr items deunicodelabels)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"
rB z#.SH NAME
%(title)s \- %(subtitle)s
)r? )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 | | d S )N)Zvisit_definition_list)r r< r r r
visit_desc~ s z ManualPageTranslator.visit_descc C s | | d S )N)Zdepart_definition_list)r r< r r r depart_desc s z ManualPageTranslator.depart_descc C s | | | | 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 | | 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 d d S )N )bodyappend)r r< r r r depart_desc_signature_line s z/ManualPageTranslator.depart_desc_signature_linec C s | | d S )N)Zvisit_definition)r r< r r r visit_desc_content s z'ManualPageTranslator.visit_desc_contentc C s | | 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 d 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 d 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 d d S )N))r` ra )r r< r r r depart_desc_parameterlist s z.ManualPageTranslator.depart_desc_parameterlistc C s | j s| jd 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 d d S )N[)r` ra )r r< r r r visit_desc_optional s z(ManualPageTranslator.visit_desc_optionalc C s | j d 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 | | d S )N)Zvisit_paragraph)r r< r r r visit_versionmodified s z*ManualPageTranslator.visit_versionmodifiedc C s | | d S )N)Zdepart_paragraph)r r< r r r depart_versionmodified s z+ManualPageTranslator.depart_versionmodifiedc s. t |tjr | jd n t | 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 | t | d S )N)
ensure_eolr visit_footnote)r r< )r r r r s z#ManualPageTranslator.visit_footnotec C sb | t|dkrR| dtdfkrR| jd| | d tj n | jd 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 d d S )Nr~ )r` ra )r r< r r r
depart_rubric s z"ManualPageTranslator.depart_rubricc C s | |d d S )Nseealso)Zvisit_admonition)r r< r r r
visit_seealso s z"ManualPageTranslator.visit_seealsoc C s | | d S )N)Zdepart_admonition)r r< r r r depart_seealso s z#ManualPageTranslator.depart_seealsoc C s2 | g }| jd7 _| jd tttj |}x|D ]}||d q.r1 r z ::= z%s r_ r~ z
.fi
)r rH r` ra r r r
productionmaxljustdefsrQ r; r! r r )r r< namesZproductionlistr maxlenlastnamer 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&| jtd|d d | jtdd 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 | jd d | | | j | jd d |dd}|dsj|dsj|dsj|d r| jjr| |kr|dr|d
d }| j d | jd d || jd d d
g t
j d S )N referencer r. Zrefurir/ zmailto:zhttp:zhttps:zftp: z ) r` ra r
visit_Textget
startswithrM Z
man_show_urlsr" extendr r )r r< urir r r visit_reference% s
z$ManualPageTranslator.visit_referencec C s& t |dd}| | t jd S )NrA #)r Textr r r )r r< textr r r visit_number_reference9 s
z+ManualPageTranslator.visit_number_referencec C s | | jd d S )Nz.sp
.ce
)r r` ra )r r< r r r visit_centered> s z#ManualPageTranslator.visit_centeredc C s | j d 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 |}| t tj|d }t ttj |}| jddd |D d | jd tj d S )Nr z, c s s | ]}| V qd S )N)r" )r* nr r r r- f s z2ManualPageTranslator.visit_acks...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 | | d S )N)Zvisit_bullet_list)r r< r r r visit_hlistj s z ManualPageTranslator.visit_hlistc C s | | 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
| |S )N)Zvisit_emphasis)r r< r r r visit_literal_emphasisv s z+ManualPageTranslator.visit_literal_emphasisc C s
| |S )N)Zdepart_emphasis)r r< r r r depart_literal_emphasisy s z,ManualPageTranslator.depart_literal_emphasisc C s
| |S )N) visit_strong)r r< r r r visit_literal_strong| s z)ManualPageTranslator.visit_literal_strongc C s
| |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
| |S )N)r )r r< r r r
visit_manpage s z"ManualPageTranslator.visit_manpagec C s
| |S )N)r )r r< r r r depart_manpage s z#ManualPageTranslator.depart_manpagec s8 t |jtjr(|jdr(| jd n t | 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(|jdr(| jd n t | 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 | jd d S t |jtjrl| jdkr>tj n.| jdkrl| jd|
| tj t
|S )Nz.IP "r r. z.SH %s
)r r5 r r r` ra r rK rI r rQ r" rL r visit_title)r r< )r r r r s
z ManualPageTranslator.visit_titlec s* t |jtjr | jd d S t |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| dd kr$| j| tjd S )NZmanpageformatr/ )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 | | d S )N)r )r r< r r r visit_math_block s z%ManualPageTranslator.visit_math_blockc C s | | d S )N)r )r r< r r r depart_math_block s z&ManualPageTranslator.depart_math_block)_r% r& r' r> r? r strr __annotations__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 s