fontlab_echopy.tooling.proteus
proteus
Build a merge overlay from the FontLab Proteus API documentation.
The Proteus checkout ships Markdown articles (api-docs) written for the
fontlab module. This module turns them into reference patches keyed by
the dotted names that :mod:fontlab_echopy.tooling.merge targets. Only names
present in the captured generated modules are emitted; the rest are
reported. Source paths, C++ names and binding-file notes are stripped, so no
machine path or implementation detail reaches a published docstring.
Classes
Complete member index
Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.
| Member | Kind | Signature | Summary |
|---|---|---|---|
COMMENT |
attribute | ||
DESCRIPTION_HEADERS |
attribute | ||
DROPPED_LINE |
attribute | ||
H1 |
attribute | ||
LINK |
attribute | ||
MEMBER_SECTIONS |
attribute | ||
NAME_HEADERS |
attribute | ||
PLACEHOLDER_DESCRIPTIONS |
attribute | ||
REFERENCE_SOURCE |
attribute | ||
SKIPPED_SECTIONS |
attribute | ||
UNSAFE |
attribute | ||
build |
function | (api_docs: Path, generated: Path) -> Overlay |
Return the Proteus overlay for the captured modules in <code>generated</code>. |
class_names |
function | (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 |
function | (path: Path, index: dict[str, set[str]], overlay: Overlay) -> None |
|
clean |
function | (lines: list[str], overlay: Overlay) -> str |
Drop implementation notes, links, rules and unsafe lines; tidy blanks. |
enum_overlay |
function | (path: Path, targets: set[str], overlay: Overlay) -> None |
Module-level enum dictionaries from the enums article. |
function_overlay |
function | (path: Path, targets: set[str], overlay: Overlay) -> None |
<code>### Name(args)</code> entries of the module reference become functions. |
lead_with_prose |
function | (doc: str) -> str |
Start with the first prose sentence, not "Inherits from" or a heading. |
member_name |
function | (cell: str) -> str | None |
<code>bool hasActive()</code><code> -> </code><code>hasActive</code><code>; </code><code>\</code>name\``<code> -> </code><code>name</code>. |
module_overlay |
function | (path: Path, targets: set[str], overlay: Overlay) -> None |
Condensed module overview: architecture, types and calling conventions. |
split_member_tables |
function | (lines: list[str]) -> tuple[list[str], list[str]] |
Separate pipe tables whose header names members from the other lines. |
split_sections |
function | (text: str) -> list[tuple[str, list[str]]] |
Split Markdown at <code>##</code><code> headings, ignoring </code><code>#</code> lines inside fences. |
table_rows |
function | (lines: list[str]) -> list[dict[str, str]] |
Parse every pipe table in <code>lines</code> into header-keyed rows. |
target_keys |
function | (generated: Path) -> dict[str, set[str]] |
Index captured names: <code>"keys"</code> holds every dotted key merge targets; every other entry maps a top-level name to the modules that define it. |
write |
function | (api_docs: Path, generated: Path, output: Path) -> dict[str, Any] |
Write the overlay JSON and return a small report. |