U
\Sh-> @ s d Z ddlmZ ddlmZmZmZ ddlmZ ddl m
Z
ddl m Z
ddl mZ ddlmZ dd lmZ dd
lmZmZ dd lmZ dd lmZ dd
lmZ ddl m Z e e Z G dd deZ!G dd dZ"G dd dee
Z#dS )z5Manual page writer, extended for Sphinx custom nodes. ) annotations)AnyIterablecast)nodes)Element)
Translator)Writer)addnodes)Builder)_admonitionlabels)logging)SphinxTranslator) format_date) NodeMatcherc s2 e Zd Zddd fdd ZddddZ ZS ) ManualPageWriterr None)builderreturnc s t || _d S N)super__init__r )selfr __class__ I/root/rtd-docs/venv/lib/python3.8/site-packages/sphinx/writers/manpage.pyr s
zManualPageWriter.__init__r c C sL t | j}| | j| j| j}tt|| _| j| | j | _
d S r ) NestedInlineTransformdocumentapplyr Zcreate_translatorr ManualPageTranslatorvisitor walkaboutastextoutput)r Z transformr# r r r translate s
zManualPageWriter.translate)__name__
__module__ __qualname__r r'
__classcell__r r r r r s r c @ s0 e Zd ZdZdddddZdddd d
Zd S ) r a
Flatten nested inline nodes:
Before:
foo=1
&bar=2
After:
foo=var
&bar=2
nodes.documentr )r r c C s
|| _ d S r )r )r r r r r r 0 s z NestedInlineTransform.__init__r )kwargsr c s t tjtjtj t| j D ]}t fdd|D r"|j
|}t t|D ]P}| | |r~|j
|d | qT|jdd|f|j}|j
|d | qTt|s"|j | q"d S )Nc 3 s | ]} |V qd S r r ).0subnodeZmatcherr r 6 s z.NestedInlineTransform.apply.. )r r literalZemphasisstronglistr findallanyparentindexreversedremoveinsertr
attributeslen)r r- nodeposr/ Znewnoder r0 r r! 3 s
zNestedInlineTransform.applyN)r( r) r* __doc__r r! r r r r r % s
r c s e Zd ZU dZi Zded< dddd fdd Zd
d d d
ZdddddZdddddZ dddddZ
dddddZ dddddZ dddddZ
dddd d Zdddd d Zdddd d!Zdddd"d#Zdddd$d%Zdddd&d'Zdddd(d)Zdddd*d+Zdddd,d-Zdddd.d/Zdddd0d1Zdddd2d3Zdddd4d5Zdddd6d7Zdddd8d9Z dddd:d;Z ddddd?Z dddd@dAZ ddddBdCZ!ddddDdEZ"ddddFdGZ#ddddHdIZ$ddddJdKZ%ddddLdMZ&ddddNdOZ'ddddPdQZ(ddddRdSZ)ddd fdTdU Z*ddddVdWZ+ddd fdXdY Z,ddddZd[Z-dddd\d]Z.dddd^d_Z/dddd`daZ0ddddbdcZ1ddddddeZ2ddddfdgZ3ddddhdiZ4ddddjdkZ5ddddldmZ6ddddndoZ7ddddpdqZ8ddddrdsZ9ddddtduZ:ddddvdwZ;ddddxdyZdddd~dZ?dddddZ@dddddZAdddddZBdddddZCdddddZDdddddZEdddddZFdddddZGdddddZHdddddZIdddddZJdddddZKdddddZLdddddZMdddddZNddd fdd ZOddd fdd ZPddd fdd ZQddd fdd ZRdddddZSdddddZTdddddZUdddddZVdddddZWdddddZXdddddZYdddddZZ Z[S )r" z%
Custom man page translator.
zdict[str, Any]_docinfor, r r )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
< t D ]\}}| || jj|< qd S )Nr titlesubtitleauthorZmanual_sectionZ title_upperdatez %b %d, %Y)language copyrightversionZ manual_group)r r in_productionlist
section_levelsettingsrE rC rF Zauthorssectionupperconfigtodayr Z today_fmtr rI rJ rK projectr
items deunicodelabels)r r r label translationr r r r K s& z ManualPageTranslator.__init__strr 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"
rF z#.SH NAME
%(title)s \- %(subtitle)s
)rC )r tmplr r r headerk s
zManualPageTranslator.headerr )r@ r c C s d S r r r r@ r r r visit_start_of_files s z(ManualPageTranslator.visit_start_of_filec C s d S r r r\ r r r depart_start_of_filev s z)ManualPageTranslator.depart_start_of_filec C s | | d S r )Zvisit_definition_listr\ r r r
visit_desc s z ManualPageTranslator.visit_descc C s | | d S r )Zdepart_definition_listr\ r r r depart_desc s z ManualPageTranslator.depart_descc C s | | | | d S r )Zvisit_definition_list_item
visit_termr\ r r r visit_desc_signature s
z)ManualPageTranslator.visit_desc_signaturec C s | | d S r )Z depart_termr\ r r r depart_desc_signature s z*ManualPageTranslator.depart_desc_signaturec C s d S r r r\ r r r visit_desc_signature_line s z.ManualPageTranslator.visit_desc_signature_linec C s | j d d S )N bodyappendr\ r r r depart_desc_signature_line s z/ManualPageTranslator.depart_desc_signature_linec C s | | d S r )Zvisit_definitionr\ r r r visit_desc_content s z'ManualPageTranslator.visit_desc_contentc C s | | d S r )Zdepart_definitionr\ r r r depart_desc_content s z(ManualPageTranslator.depart_desc_contentc C s d S r r r\ r r r visit_desc_inline s z&ManualPageTranslator.visit_desc_inlinec C s d S r r r\ r r r depart_desc_inline s z'ManualPageTranslator.depart_desc_inlinec C s d S r r r\ r r r visit_desc_name s z$ManualPageTranslator.visit_desc_namec C s d S r r r\ r r r depart_desc_name s z%ManualPageTranslator.depart_desc_namec C s d S r r r\ r r r visit_desc_addname s z'ManualPageTranslator.visit_desc_addnamec C s d S r r r\ r r r depart_desc_addname s z(ManualPageTranslator.depart_desc_addnamec C s d S r r r\ r r r visit_desc_type s z$ManualPageTranslator.visit_desc_typec C s d S r r r\ r r r depart_desc_type s z%ManualPageTranslator.depart_desc_typec C s | j d d S )Nz -> rf r\ r r r visit_desc_returns s z'ManualPageTranslator.visit_desc_returnsc C s d S r r r\ r r r depart_desc_returns s z(ManualPageTranslator.depart_desc_returnsc C s | j d d| _d S )N(r2 rg rh first_paramr\ r r r visit_desc_parameterlist s z-ManualPageTranslator.visit_desc_parameterlistc C s | j d d S )N)rf r\ r r r depart_desc_parameterlist s z.ManualPageTranslator.depart_desc_parameterlistc C s | j d d| _d S )N[r2 rw r\ r r r visit_desc_type_parameter_list s z3ManualPageTranslator.visit_desc_type_parameter_listc C s | j d d S N]rf r\ r r r depart_desc_type_parameter_list s z4ManualPageTranslator.depart_desc_type_parameter_listc C s | j s| jd nd| _ d S )N, r )rx rg rh r\ r r r visit_desc_parameter s z)ManualPageTranslator.visit_desc_parameterc C s d S r r r\ r r r depart_desc_parameter s z*ManualPageTranslator.depart_desc_parameterc C s | | d S r )r r\ r r r visit_desc_type_parameter s z.ManualPageTranslator.visit_desc_type_parameterc C s | | d S r )r r\ r r r depart_desc_type_parameter s z/ManualPageTranslator.depart_desc_type_parameterc C s | j d d S )Nr| rf r\ r r r visit_desc_optional s z(ManualPageTranslator.visit_desc_optionalc C s | j d d S r~ rf r\ r r r depart_desc_optional s z)ManualPageTranslator.depart_desc_optionalc C s d S r r r\ r r r visit_desc_annotation s z*ManualPageTranslator.visit_desc_annotationc C s d S r r r\ r r r depart_desc_annotation s z+ManualPageTranslator.depart_desc_annotationc C s | | d S r )Zvisit_paragraphr\ r r r visit_versionmodified s z*ManualPageTranslator.visit_versionmodifiedc C s | | d S r )Zdepart_paragraphr\ r r r depart_versionmodified s z+ManualPageTranslator.depart_versionmodifiedc s. t |tjr | jd n t | d S N
)r8 r7 r r5 rg rh r ra r\ r r r ra s z ManualPageTranslator.visit_termc C s
t jd S r r SkipNoder\ r r r
visit_comment s z"ManualPageTranslator.visit_commentc s | t | d S r )
ensure_eolr visit_footnoter\ r r r r s z#ManualPageTranslator.visit_footnotec C s` | t|dkrP| dtdfkrP| jd| | d tj | jd d S )Nr2 Z Footnotesz.SH r .sp
)
r r? r% r rg rh rU rP r r r\ r r r visit_rubric s
"z!ManualPageTranslator.visit_rubricc C s | j d d S r rf r\ r r r
depart_rubric s z"ManualPageTranslator.depart_rubricc C s | |d d S )Nseealso)Zvisit_admonitionr\ r r r
visit_seealso s z"ManualPageTranslator.visit_seealsoc C s | | d S r )Zdepart_admonitionr\ r r r depart_seealso s z#ManualPageTranslator.depart_seealsoc C s* | g }| jd7 _| jd tttj |}|D ]}||d q:tdd |D }d }|D ]}|d r|d |}| j| j
d d | j| | | j| j
d d | jd n |d k r| jd d
t | |
| | jd qh| jd | jd8 _tjd S )
Nr2 z.sp
.nf
Z tokennamec s s | ]}t |V qd S r )r? )r. namer r r r1 s z.r5 r z ::= z%s re r z
.fi
)r rL rg rh r r r
productionmaxljustdefsrU r? r$ r r )r r@ namesZproductionlistr maxlenlastnamer r r visit_productionlist s.
z)ManualPageTranslator.visit_productionlistc C s d S r r r\ r r r visit_production% s z%ManualPageTranslator.visit_productionc C s d S r 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> rg rh r r r r\ r r r visit_image, s
z ManualPageTranslator.visit_imagec C s | j | jd d | | | j | jd d |dd}|dr| jjr| |kr|drv|dd }| j d | jd
d || jd
d d g t
j d S ) N referencer r2 Zrefurir3 )mailto:zhttp:zhttps:zftp:r z ) rg rh r
visit_Textget
startswithrQ Z
man_show_urlsr% extendr r )r r@ urir r r visit_reference3 s
z$ManualPageTranslator.visit_referencec C s& t |dd}| | t jd S )NrE #)r Textr r r )r r@ textr r r visit_number_referenceF s
z+ManualPageTranslator.visit_number_referencec C s | | jd d S )Nz.sp
.ce
)r rg rh r\ r r r visit_centeredK s z#ManualPageTranslator.visit_centeredc C s | j d d S )Nz
.ce 0
rf r\ r r r depart_centeredO s z$ManualPageTranslator.depart_centeredc C s d S r r r\ r r r visit_compact_paragraphR s z,ManualPageTranslator.visit_compact_paragraphc C s d S r r r\ r r r depart_compact_paragraphU s z-ManualPageTranslator.depart_compact_paragraphc C s d S r r r\ r r r visit_download_referenceX s z-ManualPageTranslator.visit_download_referencec C s d S r r r\ r r r depart_download_reference[ s z.ManualPageTranslator.depart_download_referencec C s
t jd S r r r\ r r r
visit_toctree^ s z"ManualPageTranslator.visit_toctreec C s
t jd S r r r\ r r r visit_indexa s z ManualPageTranslator.visit_indexc C s
t jd S r r r\ r r r visit_tabular_col_specd s z+ManualPageTranslator.visit_tabular_col_specc C s d S r r r\ r r r visit_glossaryg s z#ManualPageTranslator.visit_glossaryc C s d S r r r\ r r r depart_glossaryj 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 r c s s | ]}| V qd S r )r% )r. nr r r r1 s s z2ManualPageTranslator.visit_acks...r )
r r bullet_listr Z list_itemr rg rh joinr )r r@ r Z
list_itemsr r r
visit_acksm s z ManualPageTranslator.visit_acksc C s | | d S r )Zvisit_bullet_listr\ r r r visit_hlistw s z ManualPageTranslator.visit_hlistc C s | | d S r )Zdepart_bullet_listr\ r r r depart_hlistz s z!ManualPageTranslator.depart_hlistc C s d S r r r\ r r r visit_hlistcol} s z#ManualPageTranslator.visit_hlistcolc C s d S r r r\ r r r depart_hlistcol s z$ManualPageTranslator.depart_hlistcolc C s
| |S r )Zvisit_emphasisr\ r r r visit_literal_emphasis s z+ManualPageTranslator.visit_literal_emphasisc C s
| |S r )Zdepart_emphasisr\ r r r depart_literal_emphasis s z,ManualPageTranslator.depart_literal_emphasisc C s
| |S r Z visit_strongr\ r r r visit_literal_strong s z)ManualPageTranslator.visit_literal_strongc C s
| |S r Z
depart_strongr\ r r r depart_literal_strong s z*ManualPageTranslator.depart_literal_strongc C s d S r r r\ r r r visit_abbreviation s z'ManualPageTranslator.visit_abbreviationc C s d S r r r\ r r r depart_abbreviation s z(ManualPageTranslator.depart_abbreviationc C s
| |S r r r\ r r r
visit_manpage s z"ManualPageTranslator.visit_manpagec C s
| |S r r r\ r r r depart_manpage s z#ManualPageTranslator.depart_manpagec s8 t |jtjr(|jdr(| jd n t | d S )N
literal_blockr )
isinstancer9 r containerr rg rh r
visit_captionr\ r r r r s z"ManualPageTranslator.visit_captionc s8 t |jtjr(|jdr(| jd n t | d S )Nr r ) r r9 r r r rg rh r depart_captionr\ 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 r2 z.SH %s
)r r9 r
r rg rh r rO rM r rU r% rP r visit_titler\ r r r r s
z ManualPageTranslator.visit_titlec s* t |jtjr | jd d S t |S )Nz"
)r r9 r
r rg rh r depart_titler\ r r r r s z!ManualPageTranslator.depart_titlec C s. d| dd kr$| j| tjd S )NZmanpageformatr3 )r splitrg rh r% r r r\ r r r visit_raw s z ManualPageTranslator.visit_rawc C s
t jd S r r r\ r r r
visit_meta s z ManualPageTranslator.visit_metac C s d S r r r\ r r r visit_inline s z!ManualPageTranslator.visit_inlinec C s d S r r r\ r r r
depart_inline s z"ManualPageTranslator.depart_inlinec C s d S r r r\ r r r
visit_math s z ManualPageTranslator.visit_mathc C s d S r r r\ r r r depart_math s z ManualPageTranslator.depart_mathc C s | | d S r )r r\ r r r visit_math_block s z%ManualPageTranslator.visit_math_blockc C s | | d S r )r r\ r r r depart_math_block s z&ManualPageTranslator.depart_math_block)\r( r) r* rB rC __annotations__r r[ r] r^ r_ r` rb rc rd ri rj rk rl rm rn ro rp rq rr rs rt ru ry r{ r} r r r r r r r r r r r ra 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" D s
r" N)$rB
__future__r typingr r r Zdocutilsr Zdocutils.nodesr 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"