scinumtools.dip.docs package

Subpackages

• scinumtools.dip.docs.pdf package
  • Submodules
  • scinumtools.dip.docs.pdf.export module
    • DocsTemplate
      • DocsTemplate.afterFlowable()
    • ExportDocsPDF
      • ExportDocsPDF.build()
      • ExportDocsPDF.docs
    • pageSettings()
  • scinumtools.dip.docs.pdf.imports module
    • ImportsSection
      • ImportsSection.data
      • ImportsSection.parse()
      • ImportsSection.parse_item()
  • scinumtools.dip.docs.pdf.injections module
    • InjectionsSection
      • InjectionsSection.nodes
      • InjectionsSection.parse()
      • InjectionsSection.parse_item()
  • scinumtools.dip.docs.pdf.node module
    • NodeSection
      • NodeSection.data
      • NodeSection.parse()
      • NodeSection.parse_node()
  • scinumtools.dip.docs.pdf.parameters module
    • ParametersSection
      • ParametersSection.data
      • ParametersSection.names
      • ParametersSection.parse()
      • ParametersSection.parse_table()
  • scinumtools.dip.docs.pdf.settings module
    • ColumnWidths()
    • HighlightReference()
    • Link()
    • Target()
    • Title()
  • scinumtools.dip.docs.pdf.sources module
    • SourcesSection
      • SourcesSection.data
      • SourcesSection.highlight_python_code()
      • SourcesSection.parse()
      • SourcesSection.parse_item()
  • scinumtools.dip.docs.pdf.types module
    • TypesSection
      • TypesSection.data
      • TypesSection.parse()
      • TypesSection.parse_table()
  • scinumtools.dip.docs.pdf.units module
    • UnitsSection
      • UnitsSection.data
      • UnitsSection.parse()
      • UnitsSection.parse_table()
  • Module contents

Submodules

scinumtools.dip.docs.documentation module

class scinumtools.dip.docs.documentation.Documentation(env: scinumtools.dip.environment.Environment, types: dict = <factory>, parameters: dict = <factory>, imports: list = <factory>, injections: list = <factory>, units: list = <factory>, sources: list = <factory>)

Bases: object

copy()

Copy a new object from self

env: Environment

imports: list

injections: list

parameters: dict

sources: list

types: dict

units: list

scinumtools.dip.docs.item_import module

class scinumtools.dip.docs.item_import.ImportItem(node, nodes)

Bases: object

idata: list

link_source: str

name: str

reference: str

source: tuple

target: str

class scinumtools.dip.docs.item_import.ImportItemNode(name: str, source: tuple, link_node: str = None, link_source: str = None)

Bases: object

link_node: str = None

link_source: str = None

name: str

source: tuple

scinumtools.dip.docs.item_injection module

class scinumtools.dip.docs.item_injection.InjectionItem(node, env)

Bases: object

isource: tuple = None

iunit: str = None

ivalue: str = None

link_isource: str

link_node: str

link_source: str

name: str

reference: str

source: tuple

target: str

scinumtools.dip.docs.item_node module

class scinumtools.dip.docs.item_node.NodeItem(name, node, node_type)

Bases: object

condition: str

constant: bool

description: str

dformat: str

dtype: str

imported: tuple

injection: bool

link_import: str

link_injection: str

link_source: str

name: str

options: list

precision: int

source: tuple

tags: list

target: str

unit: str

unsigned: bool

value: str

scinumtools.dip.docs.item_parameter module

class scinumtools.dip.docs.item_parameter.ParType(value)

Bases: Enum

An enumeration.

DCM = 2

DEC = 0

DEF = 1

DFM = 3

IMP = 6

INJ = 5

MOD = 4

class scinumtools.dip.docs.item_parameter.ParameterItem(name, node)

Bases: object

add(name, node)

counts: list

name: str

nodes: list

target: str

scinumtools.dip.docs.item_source module

class scinumtools.dip.docs.item_source.SourceItem(source)

Bases: object

code: str

link_source: str

name: str

parent: tuple

path: str

target: str

scinumtools.dip.docs.item_unit module

class scinumtools.dip.docs.item_unit.UnitItem(name, unit)

Bases: object

link_source: str

name: str

source: tuple

target: str

units: str

value: str

scinumtools.dip.docs.settings module

class scinumtools.dip.docs.settings.DocsType(value)

Bases: Flag

An enumeration.

DECLARATION = 2

DEFINITION = 4

INJECTION = 16

MODIFICATION = 8

UNKNOWN = 1

scinumtools.dip.docs.settings.ImportItemTarget(source: str, lineno: int)

scinumtools.dip.docs.settings.InjectionItemTarget(name: str, source: str, lineno: int)

scinumtools.dip.docs.settings.NodeItemTarget(name: str, source: str, lineno: int)

scinumtools.dip.docs.settings.NormalizeTargetName(name: str)

scinumtools.dip.docs.settings.ParameterItemTarget(name: str)

scinumtools.dip.docs.settings.SourceItemTarget(source: str, lineno: int | None = None)

scinumtools.dip.docs.settings.UnitItemTarget(name: str)

Module contents