Toggle Light / Dark / Auto color theme

Toggle table of contents sidebar

Source code for rstobj.markup.enum_list

# -*- coding: utf-8 -*-

"""
Enumerate list.
"""

import attr
from ..base import RstObj


@attr.s
class EnumList(RstObj):
    """
    Enumerate list class.

    Example::

        blist = Enumerate(items=["a", "b", "c"], start_num=3)
        blist.render()

    Output::

        3. a
        4. b
        5. c

    More example: http://docutils.sourceforge.net/docs/user/rst/quickref.html#enumerated-lists
    """
    items: list = attr.ib()
    start_num: int = attr.ib(default=1)