tests/test-minirst.py.out

minirst: support containers

Text can be grouped into generic containers in reStructuredText:

  .. container:: foo

     This is text inside a "foo" container.

     .. container:: bar

        This is nested inside two containers.

The minirst parser now recognizes these containers. The containers are
either pruned completely from the output (included all nested blocks)
or they are simply un-indented. So if 'foo' and 'bar' containers are
kept, the above example will result in:

     This is text inside a "foo" container.

     This is nested inside two containers.

If only 'foo' containers are kept, we get:

     This is text inside a "foo" container.

No output is made if only 'bar' containers are kept.

This feature will come in handy for implementing different levels of
help output (e.g., verbose and debug level help texts).

paragraphs formatted to fit within 60 characters:
----------------------------------------------------------------------
This is some text in the first paragraph.

  A small indented paragraph. It is followed by some lines
  containing random whitespace.

The third and final paragraph.
----------------------------------------------------------------------

paragraphs formatted to fit within 30 characters:
----------------------------------------------------------------------
This is some text in the first
paragraph.

  A small indented paragraph.
  It is followed by some lines
  containing random
  whitespace.

The third and final paragraph.
----------------------------------------------------------------------

definitions formatted to fit within 60 characters:
----------------------------------------------------------------------
A Term
  Definition. The indented lines make up the definition.
Another Term
    Another definition. The final line in the definition
    determines the indentation, so this will be indented
    with four spaces.
  A Nested/Indented Term
    Definition.
----------------------------------------------------------------------

definitions formatted to fit within 30 characters:
----------------------------------------------------------------------
A Term
  Definition. The indented
  lines make up the
  definition.
Another Term
    Another definition. The
    final line in the
    definition determines the
    indentation, so this will
    be indented with four
    spaces.
  A Nested/Indented Term
    Definition.
----------------------------------------------------------------------

literals formatted to fit within 60 characters:
----------------------------------------------------------------------
The fully minimized form is the most convenient form:

  Hello
    literal
      world

In the partially minimized form a paragraph simply ends with
space-double-colon.

  ////////////////////////////////////////
  long un-wrapped line in a literal block
  \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\

  This literal block is started with '::',
    the so-called expanded form. The paragraph
      with '::' disappears in the final output.
----------------------------------------------------------------------

literals formatted to fit within 30 characters:
----------------------------------------------------------------------
The fully minimized form is
the most convenient form:

  Hello
    literal
      world

In the partially minimized
form a paragraph simply ends
with space-double-colon.

  ////////////////////////////////////////
  long un-wrapped line in a literal block
  \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\

  This literal block is started with '::',
    the so-called expanded form. The paragraph
      with '::' disappears in the final output.
----------------------------------------------------------------------

lists formatted to fit within 60 characters:
----------------------------------------------------------------------
- This is the first list item.

  Second paragraph in the first list item.

- List items need not be separated by a blank line.
- And will be rendered without one in any case.

We can have indented lists:

  - This is an indented list item
  - Another indented list item:

      - A literal block in the middle
            of an indented list.

      (The above is not a list item since we are in the literal block.)

  Literal block with no indentation (apart from
  the two spaces added to all literal blocks).

1. This is an enumerated list (first item).
2. Continuing with the second item.
(1) foo
(2) bar
1) Another
2) List
----------------------------------------------------------------------

lists formatted to fit within 30 characters:
----------------------------------------------------------------------
- This is the first list item.

  Second paragraph in the
  first list item.

- List items need not be
  separated by a blank line.
- And will be rendered without
  one in any case.

We can have indented lists:

  - This is an indented list
    item
  - Another indented list
    item:

      - A literal block in the middle
            of an indented list.

      (The above is not a list item since we are in the literal block.)

  Literal block with no indentation (apart from
  the two spaces added to all literal blocks).

1. This is an enumerated list
   (first item).
2. Continuing with the second
   item.
(1) foo
(2) bar
1) Another
2) List
----------------------------------------------------------------------

options formatted to fit within 60 characters:
----------------------------------------------------------------------
There is support for simple option lists, but only with long
options:

--all      Output all.
--both     Output both (this description is quite long).
--long     Output all day long.
--par      This option has two paragraphs in its
           description. This is the first.

           This is the second.  Blank lines may be omitted
           between options (as above) or left in (as here).

The next paragraph looks like an option list, but lacks the
two-space marker after the option. It is treated as a normal
paragraph:

--foo bar baz
----------------------------------------------------------------------

options formatted to fit within 30 characters:
----------------------------------------------------------------------
There is support for simple
option lists, but only with
long options:

--all      Output all.
--both     Output both (this
           description is
           quite long).
--long     Output all day
           long.
--par      This option has two
           paragraphs in its
           description. This
           is the first.

           This is the second.
           Blank lines may be
           omitted between
           options (as above)
           or left in (as
           here).

The next paragraph looks like
an option list, but lacks the
two-space marker after the
option. It is treated as a
normal paragraph:

--foo bar baz
----------------------------------------------------------------------

fields formatted to fit within 60 characters:
----------------------------------------------------------------------
a   First item.
ab  Second item. Indentation and wrapping is handled
    automatically.

Next list:

small       The larger key below triggers full indentation
            here.
much too large
            This key is big enough to get its own line.
----------------------------------------------------------------------

fields formatted to fit within 30 characters:
----------------------------------------------------------------------
a   First item.
ab  Second item. Indentation
    and wrapping is handled
    automatically.

Next list:

small       The larger key
            below triggers
            full indentation
            here.
much too large
            This key is big
            enough to get its
            own line.
----------------------------------------------------------------------

containers (normal) formatted to fit within 60 characters:
----------------------------------------------------------------------
Normal output.
----------------------------------------------------------------------

containers (verbose) formatted to fit within 60 characters:
----------------------------------------------------------------------
Normal output.

Verbose output.
----------------------------------------------------------------------

containers (debug) formatted to fit within 60 characters:
----------------------------------------------------------------------
Normal output.

Initial debug output.
----------------------------------------------------------------------

containers (verbose debug) formatted to fit within 60 characters:
----------------------------------------------------------------------
Normal output.

Initial debug output.

Verbose output.

Debug output.
----------------------------------------------------------------------