o
$a= @ s d Z ddlmZmZmZmZ ddlmZ ddlm Z m
Z
m Z ddl m
Z ddl mZ ddlmZ ddlmZ dd lmZmZ dd
lmZ dd lmZ dd lm Z dd
l m Z e e Z!G dd deZ"G dd dZ#G dd deeZ$dS )z
sphinx.writers.manpage
~~~~~~~~~~~~~~~~~~~~~~
Manual page writer, extended for Sphinx custom nodes.
:copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
)AnyDictIterablecast)nodes)ElementNode TextElement)
Translator)Writer)addnodes)Builder)_admonitionlabels)logging)SphinxTranslator) format_date) NodeMatcherc s0 e Zd Zdeddf fdd ZdddZ ZS ) ManualPageWriterbuilderreturnNc s t || _d S N)super__init__r )selfr __class__ 8/usr/lib/python3/dist-packages/sphinx/writers/manpage.pyr s
zManualPageWriter.__init__c C sL t | j}| | j| j| j}tt|| _| j| | j | _
d S r ) NestedInlineTransformdocumentapplyr create_translatorr ManualPageTranslatorvisitor walkaboutastextoutput)r transformr$ r r r translate" s
zManualPageWriter.translate)r N)__name__
__module__ __qualname__r
r r)
__classcell__r r r r r s r c @ s6 e Zd ZdZdejddfddZdeddfdd ZdS )
r a
Flatten nested inline nodes:
Before:
foo=1
&bar=2
After:
foo=var
&bar=2
r r Nc C s
|| _ d S r )r )r r r r r r 6
z NestedInlineTransform.__init__kwargsc s t tjtjtj t| j D ]N}t fdd|D r_|j
|}t t|D ]*}| | |r?|j
|d | q*|jdd|fi |j}|j
|d | q*t|s_|j | qd S )Nc 3 s | ]} |V qd S r r ).0subnodematcherr r < z.NestedInlineTransform.apply.. )r r literalemphasisstronglistr traverseanyparentindexreversedremoveinsertr
attributeslen)r r/ nodeposr1 newnoder r2 r r! 9 s
zNestedInlineTransform.apply) r* r+ r, __doc__r r r r r! r r r r r + s
r c s e Zd ZU dZi Zeeef ed< de j
de ddf fdd Z defd d
Z
d eddfd d
Zd eddfddZd eddfddZd eddfddZd eddfddZd eddfddZd eddfddZd eddfddZd eddfd d Zd eddfd d Zd eddfd d!Zd eddfd"d#Zd eddfd$d%Zd eddfd&d'Z d eddfd(d)Z d eddfd*d+Z d eddfd,d-Z d eddfd.d/Z d eddfd0d1Z!d eddfd2d3Z"d eddfd4d5Z#d eddfd6d7Z$d eddfd8d9Z%d eddfd:d;Z&d eddfdd?Z(d eddfd@dAZ)d eddfdBdCZ*d eddfdDdEZ+d eddfdFdGZ,d eddf fdHdI Z-d eddfdJdKZ.d eddf fdLdM Z/d eddfdNdOZ0d eddfdPdQZ1d eddfdRdSZ2d eddfdTdUZ3d eddfdVdWZ4d eddfdXdYZ5d eddfdZd[Z6d eddfd\d]Z7d eddfd^d_Z8d eddfd`daZ9d eddfdbdcZ:d eddfdddeZ;d eddfdfdgZd eddfdldmZ?d eddfdndoZ@d eddfdpdqZAd eddfdrdsZBd eddfdtduZCd eddfdvdwZDd eddfdxdyZEd eddfdzd{ZFd eddfd|d}ZGd eddfd~dZHd eddfddZId eddfddZJd eddfddZKd eddfddZLd eddfddZMd eddfddZNd eddfddZOd eddfddZPd eddfddZQd eddf fdd ZRd eddf fdd ZSd eddf fdd ZTd eddf fdd ZUd eddfddZVd eddfddZWd eddfddZXd eddfddZYd eddfddZZd eddfddZ[d eddfddZ\d eddfddZ]d e^ddfddZ_ Z`S )r# z%
Custom man page translator.
_docinfor r r Nc s t || d| _d| _| jj| jd< | jj| jd< | jjr&| jj| jd< | jj | jd< | jd
| jd< | j j rC| j j | jd< nt
| j jpKtd | j jd
| jd< | j j| jd < | j j| jd < | j j| jd
< t D ]
\}}| || jj|< qmd S )Nr titlesubtitleauthormanual_section title_upperdatez %b %d, %Y)language copyrightversion manual_group)r r in_productionlist
section_levelsettingsrK rI rL authorssectionupperconfigtodayr today_fmtr rQ rR rS projectr items deunicodelabels)r r r label translationr r r r Q s( z ManualPageTranslator.__init__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"
rL z#.SH NAME
%(title)s \- %(subtitle)s
)rI )r tmplr r r headerq s
zManualPageTranslator.headerrE c C d S r r r rE r r r visit_start_of_filey z(ManualPageTranslator.visit_start_of_filec C rf r r rg r r r depart_start_of_file| ri z)ManualPageTranslator.depart_start_of_filec C | | d S r )visit_definition_listrg r r r
visit_desc z ManualPageTranslator.visit_descc C rk r )depart_definition_listrg r r r depart_desc rn z ManualPageTranslator.depart_descc C s | | | | d S r )visit_definition_list_item
visit_termrg r r r visit_desc_signature s
z)ManualPageTranslator.visit_desc_signaturec C rk r ) depart_termrg r r r depart_desc_signature rn z*ManualPageTranslator.depart_desc_signaturec C rf r r rg r r r visit_desc_signature_line ri z.ManualPageTranslator.visit_desc_signature_linec C | j d d S )N bodyappendrg r r r depart_desc_signature_line z/ManualPageTranslator.depart_desc_signature_linec C rk r )visit_definitionrg r r r visit_desc_content rn z'ManualPageTranslator.visit_desc_contentc C rk r )depart_definitionrg r r r depart_desc_content rn z(ManualPageTranslator.depart_desc_contentc C rf r r rg r r r visit_desc_inline ri z&ManualPageTranslator.visit_desc_inlinec C rf r r rg r r r depart_desc_inline ri z'ManualPageTranslator.depart_desc_inlinec C rf r r rg r r r visit_desc_name ri z$ManualPageTranslator.visit_desc_namec C rf r r rg r r r depart_desc_name ri z%ManualPageTranslator.depart_desc_namec C rf r r rg r r r visit_desc_addname ri z'ManualPageTranslator.visit_desc_addnamec C rf r r rg r r r depart_desc_addname ri z(ManualPageTranslator.depart_desc_addnamec C rf r r rg r r r visit_desc_type ri z$ManualPageTranslator.visit_desc_typec C rf r r rg r r r depart_desc_type ri z%ManualPageTranslator.depart_desc_typec C rw )Nz -> ry rg r r r visit_desc_returns r} z'ManualPageTranslator.visit_desc_returnsc C rf r r rg r r r depart_desc_returns ri z(ManualPageTranslator.depart_desc_returnsc C s | j d d| _d S )N(r6 )rz r{ first_paramrg r r r visit_desc_parameterlist s
z-ManualPageTranslator.visit_desc_parameterlistc C rw )N)ry rg r r r depart_desc_parameterlist r} z.ManualPageTranslator.depart_desc_parameterlistc C s | j s | jd d S d| _ d S )N, r )r rz r{ rg r r r visit_desc_parameter s
z)ManualPageTranslator.visit_desc_parameterc C rf r r rg r r r depart_desc_parameter ri z*ManualPageTranslator.depart_desc_parameterc C rw )N[ry rg r r r visit_desc_optional r} z(ManualPageTranslator.visit_desc_optionalc C rw )N]ry rg r r r depart_desc_optional r} z)ManualPageTranslator.depart_desc_optionalc C rf r r rg r r r visit_desc_annotation ri z*ManualPageTranslator.visit_desc_annotationc C rf r r rg r r r depart_desc_annotation ri z+ManualPageTranslator.depart_desc_annotationc C rk r )visit_paragraphrg r r r visit_versionmodified rn z*ManualPageTranslator.visit_versionmodifiedc C rk r )depart_paragraphrg r r r depart_versionmodified rn z+ManualPageTranslator.depart_versionmodifiedc s0 t |tjr| jd d S t | d S N
)r; r< r r: rz r{ r rr rg r r r rr s z ManualPageTranslator.visit_termc C t jr r SkipNoderg r r r
visit_comment z"ManualPageTranslator.visit_commentc s | t | d S r )
ensure_eolr visit_footnoterg r r r r z#ManualPageTranslator.visit_footnotec C s` | t|dkr(| dtdfv r(| jd| | d tj | jd d S )Nr6 Footnotesz.SH r .sp
)
r rD r& r rz r{ r` rZ r r rg r r r visit_rubric s
"z!ManualPageTranslator.visit_rubricc C rw r ry rg r r r
depart_rubric r} z"ManualPageTranslator.depart_rubricc C s | |d d S )Nseealso)visit_admonitionrg r r r
visit_seealso r} z"ManualPageTranslator.visit_seealsoc C rk r )depart_admonitionrg r r r depart_seealso rn z#ManualPageTranslator.depart_seealsoc C s& | g }| jd7 _| jd tttj |}|D ] }||d q tdd |D }d }|D ]N}|d rg|d |}| j| j
d d | j| | | j| j
d d | jd n|d urw| jd d
t | |
| | jd q4| jd | jd8 _tj)
Nr6 z.sp
.nf
tokennamec s s | ]}t |V qd S r )rD )r0 namer r r r4 r5 z.r: r z ::= z%s rx r z
.fi
)r rU rz r{ r r r
productionmaxljustdefsr` rD r% r r )r rE namesproductionlistr maxlenlastnamer r r visit_productionlist s.
z)ManualPageTranslator.visit_productionlistc C rf r r rg r r r visit_production ri z%ManualPageTranslator.visit_productionc C rf r r rg r r r depart_production" ri z&ManualPageTranslator.depart_productionc C s@ d|j v r| jtd|d d | jtdd tj)Naltz [image: %s]r z[image])rC rz r{ r r r rg r r r visit_image& s
z ManualPageTranslator.visit_imagec C s | j | jd d | | | j | jd d |dd}|ds5|ds5|ds5|d r_| jjr_| |kr_|drJ|d
d }| j d | jd d || jd d d
g t
j )N referencer r6 refurir7 zmailto:zhttp:zhttps:zftp: z ) rz r{ r
visit_Textget
startswithr[
man_show_urlsr& extendr r )r rE urir r r visit_reference- s$
z$ManualPageTranslator.visit_referencec C s" t |dd}| | t j)NrK #)r Textr r r )r rE textr r r visit_number_referenceA s
z+ManualPageTranslator.visit_number_referencec C s | | jd d S )Nz.sp
.ce
)r rz r{ rg r r r visit_centeredF r z#ManualPageTranslator.visit_centeredc C rw )Nz
.ce 0
ry rg r r r depart_centeredJ r} z$ManualPageTranslator.depart_centeredc C rf r r rg r r r visit_compact_paragraphM ri z,ManualPageTranslator.visit_compact_paragraphc C rf r r rg r r r depart_compact_paragraphP ri z-ManualPageTranslator.depart_compact_paragraphc C rf r r rg r r r visit_download_referenceS ri z-ManualPageTranslator.visit_download_referencec C rf r r rg r r r depart_download_referenceV ri z.ManualPageTranslator.depart_download_referencec C r r r rg r r r
visit_toctreeY r z"ManualPageTranslator.visit_toctreec C r r r rg r r r visit_index\ r z ManualPageTranslator.visit_indexc C r r r rg r r r visit_tabular_col_spec_ r z+ManualPageTranslator.visit_tabular_col_specc C rf r r rg r r r visit_glossaryb ri z#ManualPageTranslator.visit_glossaryc C rf r r rg r r r depart_glossarye ri z$ManualPageTranslator.depart_glossaryc C sz t tj|d }t ttj |}| t tj|d }t ttj |}| jddd |D d | jd tj )Nr r c s s | ]}| V qd S r )r& )r0 nr r r r4 n r5 z2ManualPageTranslator.visit_acks...r )
r r bullet_listr list_itemr rz r{ joinr )r rE r
list_itemsr r r
visit_acksh s z ManualPageTranslator.visit_acksc C rk r )visit_bullet_listrg r r r visit_hlistr rn z ManualPageTranslator.visit_hlistc C rk r )depart_bullet_listrg r r r depart_hlistu rn z!ManualPageTranslator.depart_hlistc C rf r r rg r r r visit_hlistcolx ri z#ManualPageTranslator.visit_hlistcolc C rf r r rg r r r depart_hlistcol{ ri z$ManualPageTranslator.depart_hlistcolc C
| |S r )visit_emphasisrg r r r visit_literal_emphasis~ r. z+ManualPageTranslator.visit_literal_emphasisc C r r )depart_emphasisrg r r r depart_literal_emphasis r. z,ManualPageTranslator.depart_literal_emphasisc C r r visit_strongrg r r r visit_literal_strong r. z)ManualPageTranslator.visit_literal_strongc C r r
depart_strongrg r r r depart_literal_strong r. z*ManualPageTranslator.depart_literal_strongc C rf r r rg r r r visit_abbreviation ri z'ManualPageTranslator.visit_abbreviationc C rf r r rg r r r depart_abbreviation ri z(ManualPageTranslator.depart_abbreviationc C r r r rg r r r
visit_manpage r. z"ManualPageTranslator.visit_manpagec C r r r rg r r r depart_manpage r. z#ManualPageTranslator.depart_manpagec : t |jtjr|jdr| jd d S t | d S )N
literal_blockr )
isinstancer> r containerr rz r{ r
visit_captionrg r r r r z"ManualPageTranslator.visit_captionc r )Nr r ) r r> r r r rz r{ r depart_captionrg r r r r r z#ManualPageTranslator.depart_captionc sv t |jtjr| jd d S t |jtjr5| jdkr tj | jdkr5| jd|
| tj t
|S )Nz.IP "r r6 z.SH %s
)r r> r r rz r{ r rY rV r r` r& rZ r visit_titlerg r r r r s
z ManualPageTranslator.visit_titlec s* t |jtjr| jd d S t |S )Nz"
)r r> r r rz r{ r depart_titlerg r r r r s z!ManualPageTranslator.depart_titlec C s* d| dd v r| j| tj)Nmanpageformatr7 )r splitrz r{ r& r r rg r r r visit_raw s z ManualPageTranslator.visit_rawc C r r r rg r r r
visit_meta r z ManualPageTranslator.visit_metac C rf r r rg r r r visit_inline ri z!ManualPageTranslator.visit_inlinec C rf r r rg r r r
depart_inline ri z"ManualPageTranslator.depart_inlinec C rf r r rg r r r
visit_math ri z ManualPageTranslator.visit_mathc C rf r r rg r r r depart_math ri z ManualPageTranslator.depart_mathc C rk r )r rg r r r visit_math_block rn z%ManualPageTranslator.visit_math_blockc C rk r )r rg r r r depart_math_block rn z&ManualPageTranslator.depart_math_blockc C s t d|jj )NzUnknown node: )NotImplementedErrorr r* rg r r r
unknown_visit r} z"ManualPageTranslator.unknown_visit)ar* r+ r, rH rI r strr __annotations__r r r
r re r rh rj rm rp rs ru rv r| r r r r r r r r r r r r r r r r r r r r r r rr 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# J s
r# N)%rH typingr r r r docutilsr docutils.nodesr r r docutils.writers.manpager
BaseTranslatorr sphinxr sphinx.buildersr
sphinx.localer r sphinx.utilr sphinx.util.docutilsr sphinx.util.i18nr sphinx.util.nodesr getLoggerr* loggerr r r# r r r r s"