docutils/test/test_writers/test_manpage.py

   1 #! /usr/bin/env python3
   2
   3 # Author: engelbert gruber <grubert@users.sourceforge.net>
   4 # Copyright: This module has been placed in the public domain.
   5
   6 """
   7 Tests for manpage writer.
   8 """
   9
  10 from test import DocutilsTestSupport
  11
  12
  13 def suite():
  14     settings = {}
  15     s = DocutilsTestSupport.PublishTestSuite('manpage', suite_settings=settings)
  16     s.generateTests(totest)
  17     return s
  18
  19
  20 indend_macros = r""".
  21 .nr rst2man-indent-level 0
  22 .
  23 .de1 rstReportMargin
  24 \\$1 \\n[an-margin]
  25 level \\n[rst2man-indent-level]
  26 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  27 -
  28 \\n[rst2man-indent0]
  29 \\n[rst2man-indent1]
  30 \\n[rst2man-indent2]
  31 ..
  32 .de1 INDENT
  33 .\" .rstReportMargin pre:
  34 . RS \\$1
  35 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  36 . nr rst2man-indent-level +1
  37 .\" .rstReportMargin post:
  38 ..
  39 .de UNINDENT
  40 . RE
  41 .\" indent \\n[an-margin]
  42 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  43 .nr rst2man-indent-level -1
  44 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  45 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  46 ..
  47 """
  48
  49 totest = {}
  50
  51 totest['blank'] = [
  52         ["",
  53         r""".\" Man page generated from reStructuredText.
  54 .
  55 """ + indend_macros + r""".TH ""  "" ""
  56 .SH NAME
  57  \-
  58 .\" Generated by docutils manpage writer.
  59 .
  60 """],
  61         [r"""Hello, world.
  62 =============
  63
  64 .. WARNING::
  65    This broke docutils-sphinx.
  66
  67 """,
  68         r""".\" Man page generated from reStructuredText.
  69 .
  70 """ + indend_macros + r""".TH "HELLO, WORLD."  "" ""
  71 .SH NAME
  72 Hello, world. \-
  73 .sp
  74 \fBWARNING:\fP
  75 .INDENT 0.0
  76 .INDENT 3.5
  77 This broke docutils\-sphinx.
  78 .UNINDENT
  79 .UNINDENT
  80 .\" Generated by docutils manpage writer.
  81 .
  82 """],
  83     ]
  84
  85 totest['simple'] = [
  86         ["""\
  87 ========
  88  simple
  89 ========
  90
  91 ---------------
  92  The way to go
  93 ---------------
  94
  95 :Author: someone@somewhere.net
  96 :Date:   2009-08-05
  97 :Copyright: public domain
  98 :Version: 0.1
  99 :Manual section: 1
 100 :Manual group: text processing
 101 :Arbitrary field: some text
 102
 103 SYNOPSIS
 104 ========
 105
 106 ::
 107
 108   K.I.S.S keep it simple.
 109
 110 DESCRIPTION
 111 ===========
 112
 113 General rule of life.
 114
 115 OPTIONS
 116 =======
 117
 118 --config=<file>         Read configuration settings from <file>, if it exists.
 119 --version, -V           Show this program's version number and exit.
 120 --help, -h              Show this help message and exit.
 121
 122 OtHeR SECTION
 123 =============
 124
 125 With mixed case.
 126
 127 .. Attention::
 128
 129    Admonition with title
 130
 131    * bullet list
 132    * bull and list
 133
 134 .. admonition:: homegrown
 135
 136    something important
 137
 138 . period at line start.
 139
 140 and . in a line and at line start
 141 .in a paragraph
 142 """,
 143         r""".\" Man page generated from reStructuredText.
 144 .
 145 """ + indend_macros + r""".TH "SIMPLE" 1 "2009-08-05" "0.1" "text processing"
 146 .SH NAME
 147 simple \- The way to go
 148 .SH SYNOPSIS
 149 .INDENT 0.0
 150 .INDENT 3.5
 151 .sp
 152 .nf
 153 .ft C
 154 K.I.S.S keep it simple.
 155 .ft P
 156 .fi
 157 .UNINDENT
 158 .UNINDENT
 159 .SH DESCRIPTION
 160 .sp
 161 General rule of life.
 162 .SH OPTIONS
 163 .INDENT 0.0
 164 .TP
 165 .BI \-\-config\fB= <file>
 166 Read configuration settings from <file>, if it exists.
 167 .TP
 168 .B  \-\-version\fP,\fB  \-V
 169 Show this program\(aqs version number and exit.
 170 .TP
 171 .B  \-\-help\fP,\fB  \-h
 172 Show this help message and exit.
 173 .UNINDENT
 174 .SH OTHER SECTION
 175 .sp
 176 With mixed case.
 177 .sp
 178 \fBATTENTION!:\fP
 179 .INDENT 0.0
 180 .INDENT 3.5
 181 Admonition with title
 182 .INDENT 0.0
 183 .IP \(bu 2
 184 bullet list
 185 .IP \(bu 2
 186 bull and list
 187 .UNINDENT
 188 .UNINDENT
 189 .UNINDENT
 190 .INDENT 0.0
 191 .INDENT 3.5
 192 .IP "homegrown"
 193 .sp
 194 something important
 195 .UNINDENT
 196 .UNINDENT
 197 .sp
 198 \&. period at line start.
 199 .sp
 200 and . in a line and at line start
 201 \&.in a paragraph
 202 .SH AUTHOR
 203 someone@somewhere.net
 204
 205 Arbitrary field: some text
 206 .SH COPYRIGHT
 207 public domain
 208 .\" Generated by docutils manpage writer.
 209 .
 210 """],
 211     ]
 212
 213 totest['table'] = [
 214         ["""\
 215         ====== =====
 216          head   and
 217         ====== =====
 218            1     2
 219           abc   so
 220         ====== =====
 221 """,
 222 '''\
 223 .\\" Man page generated from reStructuredText.
 224 .
 225 ''' + indend_macros + '''.TH ""  "" ""
 226 .SH NAME
 227  \\- \n\
 228 .INDENT 0.0
 229 .INDENT 3.5
 230 .TS
 231 center;
 232 |l|l|.
 233 _
 234 T{
 235 head
 236 T}\tT{
 237 and
 238 T}
 239 _
 240 T{
 241 1
 242 T}\tT{
 243 2
 244 T}
 245 _
 246 T{
 247 abc
 248 T}\tT{
 249 so
 250 T}
 251 _
 252 .TE
 253 .UNINDENT
 254 .UNINDENT
 255 .\\" Generated by docutils manpage writer.
 256 .
 257 ''']
 258 ]
 259
 260 totest['optiongroup'] = [
 261         ["""
 262 optin group with dot as group item
 263
 264 $
 265    bla bla bla
 266
 267 #
 268    bla bla bla
 269
 270 .
 271    bla bla bla
 272
 273 [
 274    bla bla bla
 275
 276 ]
 277    bla bla bla
 278 """,
 279         """\
 280 .\\" Man page generated from reStructuredText.
 281 .
 282 """ + indend_macros + """.TH ""  "" ""
 283 .SH NAME
 284  \\- \n\
 285 optin group with dot as group item
 286 .INDENT 0.0
 287 .TP
 288 .B $
 289 bla bla bla
 290 .UNINDENT
 291 .INDENT 0.0
 292 .TP
 293 .B #
 294 bla bla bla
 295 .UNINDENT
 296 .INDENT 0.0
 297 .TP
 298 .B \\&.
 299 bla bla bla
 300 .UNINDENT
 301 .INDENT 0.0
 302 .TP
 303 .B [
 304 bla bla bla
 305 .UNINDENT
 306 .INDENT 0.0
 307 .TP
 308 .B ]
 309 bla bla bla
 310 .UNINDENT
 311 .\\" Generated by docutils manpage writer.
 312 .
 313 """],
 314     ]
 315
 316 totest['definitionlist'] = [
 317         ["""
 318 ====================
 319 Definition List Test
 320 ====================
 321
 322 :Abstract: Docinfo is required.
 323
 324 Section
 325 =======
 326
 327 :term1:
 328
 329     Description of Term 1 Description of Term 1 Description of Term 1
 330     Description of Term 1 Description of Term 1
 331
 332     Description of Term 1 Description of Term 1 Description of Term 1
 333     Description of Term 1 Description of Term 1
 334
 335 """,
 336 '''\
 337 .\\" Man page generated from reStructuredText.
 338 .
 339 ''' + indend_macros + '''.TH "DEFINITION LIST TEST"  "" ""
 340 .SH NAME
 341 Definition List Test \\- \n\
 342 ''' + '''.SS Abstract
 343 .sp
 344 Docinfo is required.
 345 .SH SECTION
 346 .INDENT 0.0
 347 .TP
 348 .B term1
 349 Description of Term 1 Description of Term 1 Description of Term 1
 350 Description of Term 1 Description of Term 1
 351 .sp
 352 Description of Term 1 Description of Term 1 Description of Term 1
 353 Description of Term 1 Description of Term 1
 354 .UNINDENT
 355 .\\" Generated by docutils manpage writer.
 356 .
 357 '''],
 358     ]
 359
 360 totest['cmdlineoptions'] = [
 361         ["""optional arguments:
 362   -h, --help                 show this help
 363   --output FILE, -o FILE     output filename
 364   -i DEVICE, --input DEVICE  input device
 365 """,
 366         r""".\" Man page generated from reStructuredText.
 367 .
 368 """ + indend_macros + r""".TH ""  "" ""
 369 .SH NAME
 370  \-
 371 .INDENT 0.0
 372 .TP
 373 .B optional arguments:
 374 .INDENT 7.0
 375 .TP
 376 .B  \-h\fP,\fB  \-\-help
 377 show this help
 378 .TP
 379 .BI \-\-output \ FILE\fR,\fB \ \-o \ FILE
 380 output filename
 381 .TP
 382 .BI \-i \ DEVICE\fR,\fB \ \-\-input \ DEVICE
 383 input device
 384 .UNINDENT
 385 .UNINDENT
 386 .\" Generated by docutils manpage writer.
 387 .
 388 """],
 389     ]
 390
 391 totest['citation'] = [
 392         [""".. [docutils] blah blah blah
 393 .. [empty_citation]
 394 """,
 395         r""".\" Man page generated from reStructuredText.
 396 .
 397 """ + indend_macros + r""".TH ""  "" ""
 398 .SH NAME
 399  \-
 400 .IP [docutils] 5
 401 blah blah blah
 402 .IP [empty_citation] 5
 403 .\" Generated by docutils manpage writer.
 404 .
 405 """],
 406     ]
 407
 408 totest['rubric'] = [
 409         [""".. rubric:: some rubric
 410
 411 - followed by
 412 - a list
 413 """,
 414         r""".\" Man page generated from reStructuredText.
 415 .
 416 """ + indend_macros + r""".TH ""  "" ""
 417 .SH NAME
 418  \-
 419 some rubric
 420 .INDENT 0.0
 421 .IP \(bu 2
 422 followed by
 423 .IP \(bu 2
 424 a list
 425 .UNINDENT
 426 .\" Generated by docutils manpage writer.
 427 .
 428 """],
 429     ]
 430
 431 totest['double_quote'] = [
 432         ["""in "defintion list"
 433     double quotes must be escaped on macro invocations.
 434
 435 They are "escaped" anywhere.
 436 """,
 437         r""".\" Man page generated from reStructuredText.
 438 .
 439 """ + indend_macros + r""".TH ""  "" ""
 440 .SH NAME
 441  \-
 442 .INDENT 0.0
 443 .TP
 444 .B in \(dqdefintion list\(dq
 445 double quotes must be escaped on macro invocations.
 446 .UNINDENT
 447 .sp
 448 They are \(dqescaped\(dq anywhere.
 449 .\" Generated by docutils manpage writer.
 450 .
 451 """],
 452     ]
 453
 454 totest['man_header'] = [
 455         ["""
 456 ============
 457  page title
 458 ============
 459
 460 in short
 461 --------
 462
 463 :Manual section: 3
 464 :Manual group: the books
 465 :Version: 0.0
 466 :Date: 3/Nov/2022
 467
 468 Test title, docinfo to man page header.
 469 """,
 470         r""".\" Man page generated from reStructuredText.
 471 .
 472 """ + indend_macros + r""".TH "PAGE TITLE" 3 "3/Nov/2022" "0.0" "the books"
 473 .SH NAME
 474 page title \- in short
 475 .sp
 476 Test title, docinfo to man page header.
 477 .\" Generated by docutils manpage writer.
 478 .
 479 """],
 480     ]
 481
 482
 483 if __name__ == '__main__':
 484     import unittest
 485     unittest.main(defaultTest='suite')