pyexlatex.models.section package

Submodules

pyexlatex.models.section.abstract module

class pyexlatex.models.section.abstract.Abstract(content)

Bases: pyexlatex.models.documentitem.DocumentItem, pyexlatex.models.item.Item

__init__(content)

name = 'abstract'

pyexlatex.models.section.appendix module

class pyexlatex.models.section.appendix.Appendix(contents)

Bases: pyexlatex.models.section.base.TextAreaBase

Content to be placed at the end, separate from the main document.

__init__(contents)

name = 'appendices'

next_level_down_class

alias of pyexlatex.models.section.sections.Section

pyexlatex.models.section.base module

class pyexlatex.models.section.base.EnvironmentTextArea(name, modifiers=None, overlay=None)

Bases: pyexlatex.models.section.base.TextAreaMixin, pyexlatex.models.environment.Environment

__init__(name, modifiers=None, overlay=None)

wrap(other)

class pyexlatex.models.section.base.ParagraphBase(contents, title=None, **kwargs)

Bases: pyexlatex.models.section.base.TextAreaBase

__init__(contents, title=None, **kwargs)

property env_modifiers

name = 'paragraph'

repr_cols: List[str] = ['title', 'contents']

class pyexlatex.models.section.base.SectionBase(contents, title, short_title=None, **kwargs)

Bases: pyexlatex.models.section.base.TextAreaBase

__init__(contents, title, short_title=None, **kwargs)

property env_modifiers

name = 'section'

repr_cols: List[str] = ['title', 'short_title', 'contents']

class pyexlatex.models.section.base.TextAreaBase(name, contents, label=None, **kwargs)

Bases: pyexlatex.models.section.base.TextAreaMixin, pyexlatex.models.item.Item, mixins.repr.ReprMixin

repr_cols: List[str] = ['title', 'contents']

class pyexlatex.models.section.base.TextAreaMixin(name, contents, label=None, **kwargs)

Bases: pyexlatex.models.containeritem.ContainerItem

Mixin for extracting data from content then formatting it, regardless of the data type passed

__init__(name, contents, label=None, **kwargs)

format_contents(contents)

format_contents_and_build(contents)

name = 'textarea'

next_level_down_class: Optional[Type[pyexlatex.models.section.base.TextAreaBase]] = None

pyexlatex.models.section.paragraphs module

class pyexlatex.models.section.paragraphs.Paragraph(contents, title=None, **kwargs)

Bases: pyexlatex.models.section.base.ParagraphBase

A paragraph, the second smallest section block.

name = 'paragraph'

next_level_down_class

alias of pyexlatex.models.section.paragraphs.SubParagraph

class pyexlatex.models.section.paragraphs.SubParagraph(contents, title=None, **kwargs)

Bases: pyexlatex.models.section.base.ParagraphBase

Part of a paragraph, the smallest section block.

name = 'subparagraph'

pyexlatex.models.section.sections module

class pyexlatex.models.section.sections.Chapter(contents, title, short_title=None, **kwargs)

Bases: pyexlatex.models.section.base.SectionBase

A chapter of the document, the largest section type

Note: Not supported in all document types. ‘report’ is one type which can support it

name = 'chapter'

next_level_down_class

alias of pyexlatex.models.section.sections.Section

class pyexlatex.models.section.sections.Section(contents, title, short_title=None, **kwargs)

Bases: pyexlatex.models.section.base.SectionBase

A section of the document, the second largest section type.

name = 'section'

next_level_down_class

alias of pyexlatex.models.section.sections.SubSection

class pyexlatex.models.section.sections.SubSection(contents, title, short_title=None, **kwargs)

Bases: pyexlatex.models.section.base.SectionBase

A part of a section, the third largest section type.

name = 'subsection'

next_level_down_class

alias of pyexlatex.models.section.sections.SubSubSection

class pyexlatex.models.section.sections.SubSubSection(contents, title, short_title=None, **kwargs)

Bases: pyexlatex.models.section.base.SectionBase

A part of a subsection, the fourth largest section type.

name = 'subsubsection'

next_level_down_class

alias of pyexlatex.models.section.paragraphs.Paragraph