B
öÀ„\žA ã @ sž d Z ddlmZ ddlmZmZmZ ddlZ ddl m
Z
ddl m Z m
Z
ddlmZ ddlmZ e e¡ZG d d
„ d
eƒZG d d „ d eƒZG d
d„ deƒZdS )zä
sphinx.writers.manpage
~~~~~~~~~~~~~~~~~~~~~~
Manual page writer, extended for Sphinx custom nodes.
:copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
é )Únodes)Ú MACRO_DEFÚWriterÚ
TranslatorN)Úaddnodes)ÚadmonitionlabelsÚ_)Úlogging)Ú format_datec @ s e Zd Zdd„ Zdd„ ZdS )ÚManualPageWriterc C s t | ¡ || _d S )N)r Ú__init__Úbuilder)Úselfr
© r ú5lib/python3.7/site-packages/sphinx/writers/manpage.pyr " s
zManualPageWriter.__init__c C sD t | jƒ}| ¡ | j | j| j¡}|| _| j |¡ | ¡ | _d S )N) ÚNestedInlineTransformÚdocumentÚapplyr
Zcreate_translatorÚvisitorÚ walkaboutÚastextÚoutput)r Z transformr r r r Ú translate' s
zManualPageWriter.translateN)Ú__name__Ú
__module__Ú __qualname__r r r r r r r ! s r c @ s e Zd ZdZdd„ Zdd„ ZdS )r a
Flatten nested inline nodes:
Before:
foo=1
&bar=2
After:
foo=var
&bar=2
c C s
|| _ d S )N)r )r r r r r r < s z NestedInlineTransform.__init__c s¨ dd„ ‰ xš| j ˆ ¡D ]Š}t‡ fdd„|D ƒƒr|j |¡}xbt|dd … ƒD ]N}| |¡ ˆ |ƒrx|j |d |¡ qN|jd|f|j Ž}|j |d |¡ qNW qW d S )Nc S s t | tjtjtjfƒS )N)Ú
isinstancer ÚliteralZemphasisÚstrong)Únoder r r Ú is_inlineB s z.NestedInlineTransform.apply..is_inlinec 3 s | ]}ˆ |ƒV qd S )Nr )Ú.0Úsubnode)r r r ú G s z.NestedInlineTransform.apply..é Ú )
r ÚtraverseÚanyÚparentÚindexÚreversedÚremoveÚinsertÚ __class__Ú
attributes)r r Úposr" Znewnoder )r r r @ s
zNestedInlineTransform.applyN)r r r Ú__doc__r r r r r r r 1 s
r c @ s e Zd ZdZdd„ Zdd„ Zdd„ Zdd „ Zd
d „ Zd d
„ Z dd„ Z
dd„ Z dd„ Z dd„ Z
dd„ Zdd„ Zdd„ Zd d „ Zd d „ Zd d!„ Zd"d#„ Zd$d%„ Zd&d'„ Zd(d)„ Zd*d+„ Zd,d-„ Zd.d/„ Zd0d1„ Zd2d3„ Z d4d5„ Z d6d7„ Z d8d9„ Z d:d;„ Z dd?„ Z"d@dA„ Z#dBdC„ Z$dDdE„ Z%dFdG„ Z&dHdI„ Z'dJdK„ Z(dLdM„ Z)dNdO„ Z*dPdQ„ Z+dRdS„ Z,dTdU„ Z-dVdW„ Z.dXdY„ Z/dZd[„ Z0d\d]„ Z1d^d_„ Z2d`da„ Z3dbdc„ Z4ddde„ Z5dfdg„ Z6dhdi„ Z7djdk„ Z8dldm„ Z9dndo„ Z:dpdq„ Z;drds„ Zdxdy„ Z?dzd{„ Z@d|d}„ ZAd~d„ ZBd€d„ ZCd‚dƒ„ ZDd„d…„ ZEd†d‡„ ZFdˆd‰„ ZGdŠd‹„ ZHdŒd„ ZIdŽd„ ZJdd‘„ ZKd’d“„ ZLd”d•„ ZMd–d—„ ZNd˜d™„ ZOdšd›„ ZPdœd„ ZQdždŸ„ ZRd d¡„ ZSd¢S )£ÚManualPageTranslatorz
Custom translator.
c O s0 t j| f|ž|Ž || _d| _d| _| jjj| jd< | jjj | jd< | jjj
r^| jjj
| jd< | jjj | jd< | jd ¡ | jd< |j
jrš|j
j| jd< n"t|j
jpªtd ƒ|j
jd
| jd< |j
j| jd < |j
j| jd < |j
j| jd
< tjjjdk r| j t ¡ x(t ¡ D ] \}}| |¡| jj |< q W d S )Nr éÿÿÿÿÚtitleÚsubtitleZauthorZmanual_sectionZ title_upperZdatez %b %d, %Y)ÚlanguageÚ copyrightÚversionZ manual_group)r é )!ÚBaseTranslatorr r
Úin_productionlistÚ
section_levelr Zsettingsr3 Ú_docinfor4 ZauthorsÚsectionÚupperÚconfigZtodayr
Z today_fmtr r5 r6 r7 ZprojectÚsphinxÚutilÚdocutilsZ__version_info__ÚbodyÚappendr r ÚitemsÚ deunicodeÚlabels)r r
ÚargsÚkwdsZlabelZ translationr r r r W s*
z ManualPageTranslator.__init__c C s d}|| j S )Nzz.TH "%(title_upper)s" "%(manual_section)s" "%(date)s" "%(version)s" "%(manual_group)s"
.SH NAME
%(title)s \- %(subtitle)s
)r< )r Ztmplr r r Úheader} s zManualPageTranslator.headerc C s d S )Nr )r r r r r Úvisit_start_of_file… s z(ManualPageTranslator.visit_start_of_filec C s d S )Nr )r r r r r Údepart_start_of_file‰ 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ú )rC rD )r r r r r Údepart_desc_signature_line¢ s z/ManualPageTranslator.depart_desc_signature_linec 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 -> )rC rD )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 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 | j d¡ d| _d S )Nú(r$ )rC rD Ú first_param)r r r r r Úvisit_desc_parameterlistÆ s z-ManualPageTranslator.visit_desc_parameterlistc C s | j d¡ d S )Nú))rC rD )r r r r r Údepart_desc_parameterlistË s z.ManualPageTranslator.depart_desc_parameterlistc C s | j s| j d¡ nd| _ d S )Nz, r )r^ rC rD )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ú[)rC rD )r r r r r Úvisit_desc_optionalÚ s z(ManualPageTranslator.visit_desc_optionalc C s | j d¡ d S )Nú])rC rD )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_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 )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 C s* | tj¡r| j d¡ n t | |¡ d S )NÚ
)r& r r rC rD r9 rO )r r r r r rO û s z ManualPageTranslator.visit_termc C s
t j‚d S )N)r ÚSkipNode)r r r r r Ú
visit_comment s z"ManualPageTranslator.visit_commentc C s | ¡ t | |¡ d S )N)Ú
ensure_eolr9 Úvisit_footnote)r r r r r rr s z#ManualPageTranslator.visit_footnotec C sj | ¡ t|jƒdkrZ|jd ¡ }|dtdƒfkrf| j d| |¡ ¡ d ¡ t j
‚n | j d¡ d S )Nr$ r Z Footnotesz.SH rn z.sp
) rq ÚlenÚchildrenr r rC rD rF r> r ro )r r Zrubtitler r r Ú visit_rubric s z!ManualPageTranslator.visit_rubricc C s d S )Nr )r r r r r Ú
depart_rubric s z"ManualPageTranslator.depart_rubricc C s | |d¡ d S )NÚseealso)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 s" | ¡ g }| jd7 _| j d¡ x|D ]}| |d ¡ q,W tdd„ |D ƒƒ}d }x¤|D ]œ}|d rÄ|d |¡}| j | jd d ¡ | j | |¡¡ | j | jd d ¡ | j d¡ n |d k rä| j d d
t|ƒ ¡ | | ¡ | j d ¡ q^W | j d ¡ | jd8 _t
j ‚d S )
Nr$ z.sp
.nf
Z tokennamec s s | ]}t |ƒV qd S )N)rs )r! Únamer r r r# . s z.r r z ::= z%s rS rn z
.fi
) rq r: rC rD ÚmaxÚljustÚdefsrF rs r r ro )r r ÚnamesZ
productionÚmaxlenZlastnamer 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_productionC s z&ManualPageTranslator.depart_productionc C sD d|j kr&| j tdƒ|d d ¡ | j tdƒd ¡ tj‚d S )NZaltz [image: %s]rn z[image])r. rC rD r r ro )r r r r r Ú visit_imageH s
z ManualPageTranslator.visit_imagec C sÊ | j | jd d ¡ | |¡ | j | jd d ¡ | dd¡}| d¡sj| d¡sj| d¡sj| d ¡rÀ| jjjrÀ| ¡ |krÀ| d¡r–|d
d … }| j
d | jd d || jd d d
g¡ t j ‚d S )NZ referencer r$ Zrefurir% zmailto:zhttp:zhttps:zftp:é z )
rC rD r} Ú
visit_TextÚgetÚ
startswithr
r? Z
man_show_urlsr Úextendr ro )r r Zurir r r Úvisit_referenceP s
z$ManualPageTranslator.visit_referencec C s& t | dd¡¡}| |¡ t j‚d S )Nr3 ú#)r ZTextr‡ r† ro )r r Útextr r r Úvisit_number_referencef s
z+ManualPageTranslator.visit_number_referencec C s | ¡ | j d¡ d S )Nz.sp
.ce
)rq rC rD )r r r r r Úvisit_centeredl s z#ManualPageTranslator.visit_centeredc C s | j d¡ d S )Nz
.ce 0
)rC rD )r r r r r Údepart_centeredq s z$ManualPageTranslator.depart_centeredc C s d S )Nr )r r r r r Úvisit_compact_paragraphu s z,ManualPageTranslator.visit_compact_paragraphc C s d S )Nr )r r r r r Údepart_compact_paragraphy s z-ManualPageTranslator.depart_compact_paragraphc C s d S )Nr )r r r r r Úvisit_download_reference} s z-ManualPageTranslator.visit_download_referencec C s d S )Nr )r r r r r Údepart_download_reference s z.ManualPageTranslator.depart_download_referencec C s
t j‚d S )N)r ro )r r r r r Ú
visit_toctree… s z"ManualPageTranslator.visit_toctreec C s
t j‚d S )N)r ro )r r r r r Ú visit_index‰ s z ManualPageTranslator.visit_indexc C s
t j‚d S )N)r ro )r r r r r Úvisit_tabular_col_spec s z+ManualPageTranslator.visit_tabular_col_specc C s d S )Nr )r r r r r Úvisit_glossary‘ s z#ManualPageTranslator.visit_glossaryc C s d S )Nr )r r r r r Údepart_glossary• s z$ManualPageTranslator.depart_glossaryc C sF | ¡ | j d dd„ |jd jD ƒ¡d ¡ | j d¡ tj‚d S )Nz, c s s | ]}| ¡ V qd S )N)r )r! Únr r r r# œ s z2ManualPageTranslator.visit_acks..r Ú.rn )rq rC rD Újoinrt r ro )r r r r r Ú
visit_acks™ s
z ManualPageTranslator.visit_acksc C s | |¡ d S )N)Zvisit_bullet_list)r r r r r Ú visit_hlist¡ s z ManualPageTranslator.visit_hlistc C s | |¡ d S )N)Zdepart_bullet_list)r r r r r Ú depart_hlist¥ s z!ManualPageTranslator.depart_hlistc C s d S )Nr )r r r r r Úvisit_hlistcol© s z#ManualPageTranslator.visit_hlistcolc C s d S )Nr )r r r r r Údepart_hlistcol s z$ManualPageTranslator.depart_hlistcolc C s
| |¡S )N)Zvisit_emphasis)r r r r r Úvisit_literal_emphasis± s z+ManualPageTranslator.visit_literal_emphasisc C s
| |¡S )N)Zdepart_emphasis)r r r r r Údepart_literal_emphasisµ 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 C s8 t |jtjƒr(|j d¡r(| j d¡ n t | |¡ d S )NÚ
literal_blockz.sp
) r r( r Ú containerr‡ rC rD r9 Ú
visit_caption)r r r r r r Ò s z"ManualPageTranslator.visit_captionc C s8 t |jtjƒr(|j d¡r(| j d¡ n t | |¡ d S )Nr« rn ) r r( r r¬ r‡ rC rD r9 Údepart_caption)r r r r r r® Ù s z#ManualPageTranslator.depart_captionc C sx t |jtjƒr | j d¡ d S t |jtjƒrl| jdkr>tj ‚n.| jdkrl| j d|
| ¡ ¡ ¡ ¡ tj ‚t
| |¡S )Nz.IP "r r$ z.SH %s
)r r( r rw rC rD r r= r; ro rF r r> r9 Ú visit_title)r r r r r r¯ á s
z ManualPageTranslator.visit_titlec C s* t |jtjƒr | j d¡ d S t | |¡S )Nz"
)r r( r rw rC rD r9 Ú depart_title)r r r r r r° ð s z!ManualPageTranslator.depart_titlec C s. d| dd¡ ¡ kr$| j | ¡ ¡ tj‚d S )NZmanpageÚformatr% )r‡ ÚsplitrC rD r r ro )r r r r r Ú visit_raw÷ s z ManualPageTranslator.visit_rawc C s
t j‚d S )N)r ro )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_blockc C s t d|jj ƒ‚d S )NzUnknown node: )ÚNotImplementedErrorr- r )r r r r r Ú
unknown_visit s z"ManualPageTranslator.unknown_visitN)Tr r r r0 r rJ rK rL rM rN rP rQ rR rT rU rV rW rX rY rZ r[ r\ r_ ra rb rc re rg rh ri rj rk rl rm rO rp rr ru rv rx ry 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 r1 R s¢ & r1 )r0 rB r Zdocutils.writers.manpager r r r9 Zsphinx.util.docutilsr@ r Z
sphinx.localer r Z sphinx.utilr Zsphinx.util.i18nr
Z getLoggerr Zloggerr Úobjectr r1 r r r r Ú
s
!