Module pyreport.document

A module to hold the LaTeX document environment and preamble.

Classes

class Document (name='document', type='report', titlepage='notitlepage', title='', author='', date='\\today', maketitle=True, maketoc=False)

A class to hold the LaTeX document environment.

Constructor for Document.

Parameters

name : str, optional

Name of document, by default "document".

type : str, optional

Type of document, by default "report".

titlepage : str, optional

Titlepage option, by default "notitlepage".

title : str, optional

Title of document, by default "".

author : str, optional

Author of document, by default "".

date : str, optional

Date of document, by default "\today".

maketitle : bool, optional

Whether to make a title, by default True.

maketoc : bool, optional

Whether to make a table of contents, by default False.

Ancestors

• Environment
• abc.ABC

Inherited members

• Environment:
  • add_to_content
  • get_structure
  • texify

class Preamble (type='report', fontsize=12, columns='onecolumn', titlepage='notitlepage', packages=[], author='', title='', date='\\today', maketitle=True)

A class to hold the LaTeX preamble.

Constructor for Preamble.

Parameters

name : str, optional

Name of preamble, by default "preamble".

**kwargs : dict

Arguments for preamble.

Ancestors

• LaTeXObject
• abc.ABC

Class variables

var DEFAULT_PACKAGES

Inherited members

• LaTeXObject:
  • texify