plesty.sdk.commands.manual

CLI commands for generating external device manuals.

Attributes

_PDF_CSS_ASSETS

Functions

_pdf_page_css(→ str)

Return page-level CSS tuned for each generated markdown style.

_replace_device_doc_label(→ None)

Replace generic device label in generated docs with module-specific text.

_prepare_markdown_for_pdf(→ str)

Normalize markdown so md2pdf renders parameter lists reliably.

_discover_modules_from_init(→ list[str])

Discover importable package names from __init__.py files under a device root.

_infer_default_module_name(→ str | None)

Infer a sensible default import module from device root contents.

generate_command(→ None)

Generate short.md, table.md and googledoc.py for an external device package.

manual_command(→ None)

Generate and manage external device manuals.

Module Contents

plesty.sdk.commands.manual._PDF_CSS_ASSETS
plesty.sdk.commands.manual._pdf_page_css(style: str) → str

Return page-level CSS tuned for each generated markdown style.

Parameters:

style (str)

Return type:

str

plesty.sdk.commands.manual._replace_device_doc_label(file_path: pathlib.Path, module_name: str) → None

Replace generic device label in generated docs with module-specific text.

Parameters:

  • file_path (pathlib.Path)

  • module_name (str)

Return type:

None

plesty.sdk.commands.manual._prepare_markdown_for_pdf(markdown_text: str, style: str) → str

Normalize markdown so md2pdf renders parameter lists reliably.

Parameters:

  • markdown_text (str)

  • style (str)

Return type:

str

plesty.sdk.commands.manual._discover_modules_from_init(device_root: pathlib.Path) → list[str]

Discover importable package names from __init__.py files under a device root.

Parameters:

device_root (pathlib.Path)

Return type:

list[str]

plesty.sdk.commands.manual._infer_default_module_name(device_root: pathlib.Path) → str | None

Infer a sensible default import module from device root contents.

Parameters:

device_root (pathlib.Path)

Return type:

str | None

plesty.sdk.commands.manual.generate_command(context: plesty.sdk.context.ApplicationContext, module_name: str | None, output_dir: pathlib.Path | None, with_pdf: bool) → None

Generate short.md, table.md and googledoc.py for an external device package.

Operates on the project directory set via the global –project-dir option (defaults to the current working directory).

Parameters:
Return type:

None

plesty.sdk.commands.manual.manual_command() → None

Generate and manage external device manuals.

Return type:

None