test/test_writers/test_manpage.py

   1 #! /usr/bin/env python
   2
   3 # $Id: test_latex2e.py 6003 2009-06-27 20:44:09Z milde $
   4 # Author: engelbert gruber <grubert@users.sourceforge.net>
   5 # Copyright: This module has been placed in the public domain.
   6
   7 """
   8 Tests for manpage writer.
   9 """
  10
  11 from __init__ import DocutilsTestSupport
  12
  13 from docutils._compat import b
  14
  15 def suite():
  16     settings = {}
  17     s = DocutilsTestSupport.PublishTestSuite('manpage', suite_settings=settings)
  18     s.generateTests(totest)
  19     return s
  20
  21 indend_macros = r""".
  22 .nr rst2man-indent-level 0
  23 .
  24 .de1 rstReportMargin
  25 \\$1 \\n[an-margin]
  26 level \\n[rst2man-indent-level]
  27 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  28 -
  29 \\n[rst2man-indent0]
  30 \\n[rst2man-indent1]
  31 \\n[rst2man-indent2]
  32 ..
  33 .de1 INDENT
  34 .\" .rstReportMargin pre:
  35 . RS \\$1
  36 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  37 . nr rst2man-indent-level +1
  38 .\" .rstReportMargin post:
  39 ..
  40 .de UNINDENT
  41 . RE
  42 .\" indent \\n[an-margin]
  43 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  44 .nr rst2man-indent-level -1
  45 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  46 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  47 ..
  48 """
  49
  50 totest = {}
  51
  52 totest['blank'] = [
  53         ["",
  54         r""".\" Man page generated from reStructuredText.
  55 .
  56 .TH   "" "" ""
  57 .SH NAME
  58  \-
  59 """+indend_macros+
  60 r""".\" Generated by docutils manpage writer.
  61 .
  62 """],
  63         [r"""Hello, world.
  64 =============
  65
  66 .. WARNING::
  67    This broke docutils-sphinx.
  68
  69 """,
  70         r""".\" Man page generated from reStructuredText.
  71 .
  72 .TH HELLO, WORLD.  "" "" ""
  73 .SH NAME
  74 Hello, world. \-
  75 """+indend_macros+
  76 r""".sp
  77 \fBWARNING:\fP
  78 .INDENT 0.0
  79 .INDENT 3.5
  80 This broke docutils\-sphinx.
  81 .UNINDENT
  82 .UNINDENT
  83 .\" Generated by docutils manpage writer.
  84 .
  85 """],
  86     ]
  87
  88 totest['simple'] = [
  89         ["""\
  90 ========
  91  simple
  92 ========
  93
  94 ---------------
  95  The way to go
  96 ---------------
  97
  98 :Author: someone@somewhere.net
  99 :Date:   2009-08-05
 100 :Copyright: public domain
 101 :Version: 0.1
 102 :Manual section: 1
 103 :Manual group: text processing
 104 :Arbitrary field: some text
 105
 106 SYNOPSIS
 107 ========
 108
 109 ::
 110
 111   K.I.S.S keep it simple.
 112
 113 DESCRIPTION
 114 ===========
 115
 116 General rule of life.
 117
 118 OPTIONS
 119 =======
 120
 121 --config=<file>         Read configuration settings from <file>, if it exists.
 122 --version, -V           Show this program's version number and exit.
 123 --help, -h              Show this help message and exit.
 124
 125 OtHeR SECTION
 126 =============
 127
 128 With mixed case.
 129
 130 .. Attention::
 131
 132    Admonition with title
 133
 134    * bullet list
 135    * bull and list
 136
 137 .. admonition:: homegrown
 138
 139    something important
 140
 141 """,
 142         r""".\" Man page generated from reStructuredText.
 143 .
 144 .TH SIMPLE 1 "2009-08-05" "0.1" "text processing"
 145 .SH NAME
 146 simple \- The way to go
 147 """+indend_macros+
 148 r""".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 .SH AUTHOR
 198 someone@somewhere.net
 199
 200 Arbitrary field: some text
 201 .SH COPYRIGHT
 202 public domain
 203 .\" Generated by docutils manpage writer.
 204 .
 205 """],
 206     ]
 207
 208 totest['table'] = [
 209         ["""\
 210         ====== =====
 211          head   and
 212         ====== =====
 213            1     2
 214           abc   so
 215         ====== =====
 216 """,
 217 '''\
 218 .\\" Man page generated from reStructuredText.
 219 .
 220 .TH   "" "" ""
 221 .SH NAME
 222  \\- \n\
 223 '''+indend_macros+
 224 '''.INDENT 0.0
 225 .INDENT 3.5
 226 .TS
 227 center;
 228 |l|l|.
 229 _
 230 T{
 231 head
 232 T}\tT{
 233 and
 234 T}
 235 _
 236 T{
 237 1
 238 T}\tT{
 239 2
 240 T}
 241 _
 242 T{
 243 abc
 244 T}\tT{
 245 so
 246 T}
 247 _
 248 .TE
 249 .UNINDENT
 250 .UNINDENT
 251 .\\" Generated by docutils manpage writer.
 252 .
 253 ''']
 254 ]
 255
 256 totest['optiongroup'] = [
 257         ["""
 258 optin group with dot as group item
 259
 260 $
 261    bla bla bla
 262
 263 #
 264    bla bla bla
 265
 266 .
 267    bla bla bla
 268
 269 [
 270    bla bla bla
 271
 272 ]
 273    bla bla bla
 274 """,
 275         """\
 276 .\\" Man page generated from reStructuredText.
 277 .
 278 .TH   "" "" ""
 279 .SH NAME
 280  \\- \n\
 281 """+indend_macros+
 282 """optin group with dot as group item
 283 .INDENT 0.0
 284 .TP
 285 .B $
 286 bla bla bla
 287 .UNINDENT
 288 .INDENT 0.0
 289 .TP
 290 .B #
 291 bla bla bla
 292 .UNINDENT
 293 .INDENT 0.0
 294 .TP
 295 .B .
 296 bla bla bla
 297 .UNINDENT
 298 .INDENT 0.0
 299 .TP
 300 .B [
 301 bla bla bla
 302 .UNINDENT
 303 .INDENT 0.0
 304 .TP
 305 .B ]
 306 bla bla bla
 307 .UNINDENT
 308 .\\" Generated by docutils manpage writer.
 309 ."""],
 310     ]
 311
 312 totest['definitionlist'] = [
 313         ["""
 314 ====================
 315 Definition List Test
 316 ====================
 317
 318 :Abstract: Docinfo is required.
 319
 320 Section
 321 =======
 322
 323 :term1:
 324
 325     Description of Term 1 Description of Term 1 Description of Term 1
 326     Description of Term 1 Description of Term 1
 327
 328     Description of Term 1 Description of Term 1 Description of Term 1
 329     Description of Term 1 Description of Term 1
 330
 331 """,
 332 '''\
 333 .\\" Man page generated from reStructuredText.
 334 .
 335 .TH DEFINITION LIST TEST  "" "" ""
 336 .SH NAME
 337 Definition List Test \\- \n\
 338 '''+indend_macros+
 339 '''.SS Abstract
 340 .sp
 341 Docinfo is required.
 342 .SH SECTION
 343 .INDENT 0.0
 344 .TP
 345 .B term1
 346 Description of Term 1 Description of Term 1 Description of Term 1
 347 Description of Term 1 Description of Term 1
 348 .sp
 349 Description of Term 1 Description of Term 1 Description of Term 1
 350 Description of Term 1 Description of Term 1
 351 .UNINDENT
 352 .\\" Generated by docutils manpage writer.
 353 .'''],
 354     ]
 355
 356
 357 if __name__ == '__main__':
 358     import unittest
 359     unittest.main(defaultTest='suite')