pyexlatex.models.format package

Subpackages

• pyexlatex.models.format.code package
  • Submodules
  • pyexlatex.models.format.code.minted module
  • pyexlatex.models.format.code.python module
• pyexlatex.models.format.paragraph package
  • Submodules
  • pyexlatex.models.format.paragraph.justifying module
  • pyexlatex.models.format.paragraph.multicol module
  • pyexlatex.models.format.paragraph.raggedright module
  • pyexlatex.models.format.paragraph.sloppy module
• pyexlatex.models.format.text package
  • Subpackages
    • pyexlatex.models.format.text.color package
      • Subpackages
        • pyexlatex.models.format.text.color.deftypes package
          • Submodules
          • pyexlatex.models.format.text.color.deftypes.base module
          • pyexlatex.models.format.text.color.deftypes.hex module
          • pyexlatex.models.format.text.color.deftypes.rgb module
      • Submodules
      • pyexlatex.models.format.text.color.main module
  • Submodules
  • pyexlatex.models.format.text.bold module
  • pyexlatex.models.format.text.italics module
  • pyexlatex.models.format.text.linespacing module
  • pyexlatex.models.format.text.monospace module
  • pyexlatex.models.format.text.nohyphens module
  • pyexlatex.models.format.text.smallcaps module
  • pyexlatex.models.format.text.text module
  • pyexlatex.models.format.text.underline module

Submodules

pyexlatex.models.format.adjustbox module

class pyexlatex.models.format.adjustbox.AdjustBox(contents, adjust_options)

Bases: pyexlatex.models.section.base.TextAreaBase

__init__(contents, adjust_options)

name = 'adjustbox'

property options_str: str

Return type

str

pyexlatex.models.format.breaks module

class pyexlatex.models.format.breaks.Break

Bases: pyexlatex.models.mixins.StringAdditionMixin

class pyexlatex.models.format.breaks.LineBreak

Bases: pyexlatex.models.format.breaks.Break

__init__()

class pyexlatex.models.format.breaks.OutputLineBreak(size_adjustment=None)

Bases: pyexlatex.models.format.breaks.Break, mixins.repr.ReprMixin

Create an intentional line break in text

__init__(size_adjustment=None)

repr_cols: List[str] = ['size_adjustment']

class pyexlatex.models.format.breaks.TableLineBreak(size_adjustment=None)

Bases: pyexlatex.models.format.breaks.Break, mixins.repr.ReprMixin

A line break character to be used in LaTeX tables

__init__(size_adjustment=None)

repr_cols: List[str] = ['size_adjustment']

pyexlatex.models.format.captionsetup module

class pyexlatex.models.format.captionsetup.CaptionSetup(target='figure', relative_sizes=None, options=None)

Bases: pyexlatex.models.item.SimpleItem

Control formatting of captions for tables and figures

__init__(target='figure', relative_sizes=None, options=None)

name = 'captionsetup'

pyexlatex.models.format.centering module

class pyexlatex.models.format.centering.Center(content, **kwargs)

Bases: pyexlatex.models.section.base.TextAreaBase

Align the passed contents to the center of the container

__init__(content, **kwargs)

name = 'center'

class pyexlatex.models.format.centering.Centering(overlay=None)

Bases: pyexlatex.models.item.NoOptionsNoContentsItem

__init__(overlay=None)

name = 'centering'

pyexlatex.models.format.fills module

class pyexlatex.models.format.fills.HFill

Bases: pyexlatex.models.item.NoOptionsNoContentsItem

Horizontal fill, put between items to put horizontal spacing between them.

__init__()

name = 'hfill'

class pyexlatex.models.format.fills.VFill

Bases: pyexlatex.models.item.NoOptionsNoContentsItem

Vertical fill, put between items to put vertical spacing between them.

__init__()

name = 'vfill'

pyexlatex.models.format.hangindent module

class pyexlatex.models.format.hangindent.HangIndent(hang_by=1)

Bases: pyexlatex.models.item.EqualsItem

__init__(hang_by=1)

name = 'hangindent'

pyexlatex.models.format.hline module

class pyexlatex.models.format.hline.HLine(thickness=0.4)

Bases: pyexlatex.models.format.rule.Rule

Draws a horizontal line across the text width.

__init__(thickness=0.4)

pyexlatex.models.format.hspace module

class pyexlatex.models.format.hspace.HSpace(height=0.5, units='cm')

Bases: pyexlatex.models.item.SimpleItem

Manually insert horizontal spacing, of a given length.

__init__(height=0.5, units='cm')

name = 'hspace'

pyexlatex.models.format.join module

class pyexlatex.models.format.join.Joined(contents, join_with='')

Bases: pyexlatex.models.section.base.TextAreaMixin, pyexlatex.models.item.ItemBase

Applies string.join on contents when output string is created, but retains content objects.

__init__(contents, join_with='')

pyexlatex.models.format.noindent module

class pyexlatex.models.format.noindent.NoIndent(contents, **kwargs)

Bases: pyexlatex.models.section.base.TextAreaMixin, pyexlatex.models.item.NoOptionsNoContentsItem

Do not have an indent for the current paragraph

__init__(contents, **kwargs)

name = 'noindent'

pyexlatex.models.format.nolinebreak module

class pyexlatex.models.format.nolinebreak.NoLineBreak(contents, alternative='ragged')

Bases: pyexlatex.models.template.Template

Prevents a line break within text, where a hyphen would normally be placed.

Notes:

Using this will have side effects to the entire paragraph, depending on the alternative chosen. See the docstring for alternative.

__init__(contents, alternative='ragged')

Parameters

• contents –

• alternative (str) – ‘ragged’ or ‘sloppy’. As the word won’t be broken, there must be some alternative. Passing ‘ragged’ will make all the other words on the first line stay in the same position, so that a gap will appear at the end of the line where the NoLineBreak word would have started originally. Passing ‘sloppy’ will make it so that the first line’s words spacing gets stretched so that there is still right alignment on that line, despite the NoLineBreak word being moved to the next line. Note: This will affect the entire paragraph, not just the NoLineBreak word.

name = 'nohyphens'

pyexlatex.models.format.nopagebreak module

class pyexlatex.models.format.nopagebreak.NoPageBreak(contents, **kwargs)

Bases: pyexlatex.models.environmenttemplate.EnvironmentTemplate

Contents within this environment will not have a page break come in the middle. Contents will instead be moved onto the next page if a break would have occurred.

begin_def = '\\par\\nobreak\\vfil\\penalty0\\vfilneg\\vtop\\bgroup'

end_def = '\\par\\xdef\\tpd{\\the\\prevdepth}\\egroup\\prevdepth=\\tpd'

name = 'absolutelynopagebreak'

pyexlatex.models.format.paragraphindent module

class pyexlatex.models.format.paragraphindent.ParagraphIndent(contents, left_adjust=1, right_adjust=0)

Bases: pyexlatex.models.section.base.TextAreaBase, pyexlatex.models.item.Item

Used for setting paragraph indents, from the left or right.

__init__(contents, left_adjust=1, right_adjust=0)

name = 'adjustwidth'

property options_str: str

Return type

str

pyexlatex.models.format.raw module

class pyexlatex.models.format.raw.Raw(contents)

Bases: pyexlatex.models.mixins.IsSpecificClassMixin, pyexlatex.models.item.IsLatexItemMixin, mixins.attrequals.EqOnAttrsMixin

Don’t replace latex characters in this blocks such as or %, useful for adding latex commands or comments manually.

__init__(contents)

equal_attrs = ('contents',)

pyexlatex.models.format.rule module

class pyexlatex.models.format.rule.Rule(length=2, thickness=0.4)

Bases: pyexlatex.models.item.MultiOptionSimpleItem

Draw a horizontal line of given length and thickness

__init__(length=2, thickness=0.4)

property length_str

name = 'rule'

property thickness_str

pyexlatex.models.format.sectionnum module

class pyexlatex.models.format.sectionnum.SectionNumberingFormatter(section_type, section_format)

Bases: pyexlatex.models.commands.renewcommand.ReNewCommand

applies formatting for section numbers

__init__(section_type, section_format)

classmethod list_from_string_format_dict(string_format_dict)

Args:

string_format_dict: e.g. dict(

section=r’Roman{section}’, subsection=r’Alph{subsection}’

)

Returns:

Return type

List[SectionNumberingFormatter]

pyexlatex.models.format.vspace module

class pyexlatex.models.format.vspace.VSpace(height=0.5, units='cm')

Bases: pyexlatex.models.item.SimpleItem

Manually insert vertical spacing, of a given height.

__init__(height=0.5, units='cm')

name = 'vspace'