Skip to content

fontlab_echopy.tooling.proteus · declarations 001

Back to fontlab_echopy.tooling.proteus

COMMENT module-attribute

COMMENT

DESCRIPTION_HEADERS module-attribute

DESCRIPTION_HEADERS

DROPPED_LINE module-attribute

DROPPED_LINE

H1 module-attribute

H1
LINK

MEMBER_SECTIONS module-attribute

MEMBER_SECTIONS

NAME_HEADERS module-attribute

NAME_HEADERS

PLACEHOLDER_DESCRIPTIONS module-attribute

PLACEHOLDER_DESCRIPTIONS

REFERENCE_SOURCE module-attribute

REFERENCE_SOURCE

SKIPPED_SECTIONS module-attribute

SKIPPED_SECTIONS

UNSAFE module-attribute

UNSAFE

build

build(api_docs: Path, generated: Path) -> Overlay

Return the Proteus overlay for the captured modules in generated.

class_names

class_names(text: str, stem: str, owners: dict[str, set[str]]) -> list[str]

Python names declared by an article, falling back to its file stem.

class_overlay

class_overlay(path: Path, index: dict[str, set[str]], overlay: Overlay) -> None

clean

clean(lines: list[str], overlay: Overlay) -> str

Drop implementation notes, links, rules and unsafe lines; tidy blanks.

enum_overlay

enum_overlay(path: Path, targets: set[str], overlay: Overlay) -> None

Module-level enum dictionaries from the enums article.

function_overlay

function_overlay(path: Path, targets: set[str], overlay: Overlay) -> None

### Name(args) entries of the module reference become functions.

lead_with_prose

lead_with_prose(doc: str) -> str

Start with the first prose sentence, not "Inherits from" or a heading.

Tools and tooltips show only the first line, so the inheritance note moves after the first prose paragraph and the remaining text keeps its order.

member_name

member_name(cell: str) -> str | None

bool hasActive() -> hasActive; \`name\``` ->name``.

module_overlay

module_overlay(path: Path, targets: set[str], overlay: Overlay) -> None

Condensed module overview: architecture, types and calling conventions.

split_member_tables

split_member_tables(lines: list[str]) -> tuple[list[str], list[str]]

Separate pipe tables whose header names members from the other lines.

split_sections

split_sections(text: str) -> list[tuple[str, list[str]]]

Split Markdown at ## headings, ignoring # lines inside fences.

table_rows

table_rows(lines: list[str]) -> list[dict[str, str]]

Parse every pipe table in lines into header-keyed rows.

target_keys

target_keys(generated: Path) -> dict[str, set[str]]

Index captured names: "keys" holds every dotted key merge targets; every other entry maps a top-level name to the modules that define it.

write

write(api_docs: Path, generated: Path, output: Path) -> dict[str, Any]

Write the overlay JSON and return a small report.