Module pyreport.segment

This module contains the Segment class, which is used to hold the LaTeX chapter, section, subsection, etc. environments.

Classes

class Segment (name, segment_type, label='', asterisk=False)

A class to hold the LaTeX chapter, section, subsection, etc. environments.

Constructor for Segment.

Parameters

name : str

Name of segment.

segment_type : {"chapter", "section", "subsection", "subsubsection", "paragraph"}

Type of segment.

label : str, optional

Label of segment, by default "".

asterisk : bool, optional

Whether to use asterisk, by default False.

Ancestors

• Environment
• abc.ABC

Methods

def add_to_content(self, obj)

Adds an object to the segment.

Parameters

obj : Environment, LaTeXObject

Object to add to segment.

Raises

TypeError

Raised when Segment of lower level is tried to be added.

Inherited members

• Environment:
  • get_structure
  • texify