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„ deƒZ"G dd„ dƒZ#G dd„ deeƒZ$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.
é )ÚAnyÚDictÚIterableÚcast)Únodes)ÚElementÚNodeÚ TextElement)Ú
Translator)ÚWriter)Úaddnodes)ÚBuilder)Ú_Úadmonitionlabels)Úlogging)ÚSphinxTranslator)Ú format_date)Ú NodeMatcherc s0 e Zd Zdeddf‡ fdd„ Zddd„Z‡ ZS ) ÚManualPageWriterÚbuilderÚreturnNc 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 ) ÚNestedInlineTransformÚdocumentÚapplyr Úcreate_translatorr ÚManualPageTranslatorÚvisitorÚ walkaboutÚastextÚoutput)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 ZdZdejddfdd„Zdeddfdd „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 )Ú.0Úsubnode©Úmatcherr r Ú < ó € z.NestedInlineTransform.apply..é Ú )r r ÚliteralÚemphasisÚstrongÚlistr ÚtraverseÚanyÚparentÚindexÚreversedÚremoveÚinsertr Ú
attributesÚlen)r r/ ÚnodeÚposr1 Ú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 eddfdd„Zd eddfdd„Zd eddfdd„Zd eddfdd„Zd eddfdd„Zd eddfdd„Zd eddfdd„Zd 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 eddfd0d1„Z!d eddfd2d3„Z"d eddfd4d5„Z#d eddfd6d7„Z$d eddfd8d9„Z%d eddfd:d;„Z&d eddfdd?„Z(d eddfd@dA„Z)d eddfdBdC„Z*d eddfdDdE„Z+d eddfdFdG„Z,d eddf‡ fdHdI„ Z-d eddfdJdK„Z.d eddf‡ fdLdM„ Z/d eddfdNdO„Z0d eddfdPdQ„Z1d eddfdRdS„Z2d eddfdTdU„Z3d eddfdVdW„Z4d eddfdXdY„Z5d eddfdZd[„Z6d eddfd\d]„Z7d eddfd^d_„Z8d eddfd`da„Z9d eddfdbdc„Z:d eddfddde„Z;d eddfdfdg„Zd eddfdldm„Z?d eddfdndo„Z@d eddfdpdq„ZAd eddfdrds„ZBd eddfdtdu„ZCd eddfdvdw„ZDd eddfdxdy„ZEd eddfdzd{„ZFd eddfd|d}„ZGd eddfd~d„ZHd eddfd€d„ZId eddfd‚dƒ„ZJd eddfd„d…„ZKd eddfd†d‡„ZLd eddfdˆd‰„ZMd eddfdŠd‹„ZNd eddfdŒd„ZOd eddfdŽd„ZPd eddfdd‘„ZQd eddf‡ fd’d“„ ZRd eddf‡ fd”d•„ ZSd eddf‡ fd–d—„ ZTd eddf‡ fd˜d™„ ZUd eddfdšd›„ZVd eddfdœd„ZWd eddfdždŸ„ZXd eddfd d¡„ZYd eddfd¢d£„ZZd eddfd¤d¥„Z[d eddfd¦d§„Z\d eddfd¨d©„Z]d e^ddfdªd«„Z_‡ 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 éÿÿÿÿÚtitleÚsubtitleÚauthorÚmanual_sectionÚ title_upperÚdatez %b %d, %Y)ÚlanguageÚ copyrightÚversionÚ manual_group)r r Úin_productionlistÚ
section_levelÚsettingsrK rI rL ÚauthorsÚsectionÚupperÚconfigÚtodayr Ú today_fmtr rQ rR rS Úprojectr ÚitemsÚ deunicodeÚlabels)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ú ©ÚbodyÚappendrg 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 | j d¡ 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 | tj¡ƒr| j d¡ 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 j‚r ©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(| ¡ dtdƒfv r(| j d| | ¡ ¡ ¡ d ¡ tj ‚| j d¡ 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 )NÚseealso)Ú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 _| j d¡ tttj |ƒ}|D ] }| |d ¡ q tdd„ |D ƒƒ}d }|D ]N}|d rg|d |¡}| j | j
d d ¡ | j | |¡¡ | j | j
d d ¡ | j d¡ n|d urw| j d d
t |ƒ ¡ |
| ¡ | j d ¡ q4| j d ¡ | 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 Ú
productionÚmaxÚljustÚdefsr` rD r% r r¢ )r rE ÚnamesÚproductionlistr³ ÚmaxlenÚlastnamer 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| j tdƒ|d d ¡ | j tdƒd ¡ tj‚)NÚaltz [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¡}| d¡s5| d¡s5| d¡s5| d ¡r_| jjr_| ¡ |kr_| d¡rJ|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_TextÚgetÚ
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 | ¡ | j d¡ 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 |ƒ}| j d dd„ |D ƒ¡d ¡ | j d¡ 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 |jtjƒr|j d¡r| j d¡ 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 |jtjƒr| j d¡ d S t |jtjƒr5| jdkr tj ‚| jdkr5| j d|
| ¡ ¡ ¡ ¡ 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 |jtjƒr| j d¡ 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‚)NÚmanpageÚformatr7 )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"