scinumtools.dip.docs.pdf package

Submodules

scinumtools.dip.docs.pdf.export module

class scinumtools.dip.docs.pdf.export.DocsTemplate(filename, **kw)

Bases: BaseDocTemplate

afterFlowable(flowable)

Registers TOC entries.

class scinumtools.dip.docs.pdf.export.ExportDocsPDF(docs: Documentation, **kwargs)

Bases: object

build(file_path: str, title, intro=None)
docs: Documentation
scinumtools.dip.docs.pdf.export.pageSettings(canvas, doc)

scinumtools.dip.docs.pdf.imports module

class scinumtools.dip.docs.pdf.imports.ImportsSection(data)

Bases: object

data: list
parse()
parse_item(item)

scinumtools.dip.docs.pdf.injections module

class scinumtools.dip.docs.pdf.injections.InjectionsSection(data)

Bases: object

nodes: list
parse()
parse_item(item)

scinumtools.dip.docs.pdf.node module

class scinumtools.dip.docs.pdf.node.NodeSection(data)

Bases: object

data: list
parse()
parse_node(name, node)

scinumtools.dip.docs.pdf.parameters module

class scinumtools.dip.docs.pdf.parameters.ParametersSection(data)

Bases: object

data: list
names: list
parse()
parse_table()

scinumtools.dip.docs.pdf.settings module

scinumtools.dip.docs.pdf.settings.ColumnWidths(ratios: list)
scinumtools.dip.docs.pdf.settings.HighlightReference(text: str)
scinumtools.dip.docs.pdf.settings.Target(key: str, name: str = '')
scinumtools.dip.docs.pdf.settings.Title(name: str = '')

scinumtools.dip.docs.pdf.sources module

class scinumtools.dip.docs.pdf.sources.SourcesSection(data: list)

Bases: object

data: list
highlight_python_code(item)
parse()
parse_item(item)

scinumtools.dip.docs.pdf.types module

class scinumtools.dip.docs.pdf.types.TypesSection(data: dict)

Bases: object

data: dict
parse()
parse_table()

scinumtools.dip.docs.pdf.units module

class scinumtools.dip.docs.pdf.units.UnitsSection(data: list)

Bases: object

data: list
parse()
parse_table()

Module contents