plesty.sdk.commands.manual
==========================

.. py:module:: plesty.sdk.commands.manual

.. autoapi-nested-parse::

   CLI commands for generating external device manuals.



Attributes
----------

.. autoapisummary::

   plesty.sdk.commands.manual._PDF_CSS_ASSETS


Functions
---------

.. autoapisummary::

   plesty.sdk.commands.manual._pdf_page_css
   plesty.sdk.commands.manual._replace_device_doc_label
   plesty.sdk.commands.manual._prepare_markdown_for_pdf
   plesty.sdk.commands.manual._discover_modules_from_init
   plesty.sdk.commands.manual._infer_default_module_name
   plesty.sdk.commands.manual.generate_command
   plesty.sdk.commands.manual.manual_command


Module Contents
---------------

.. py:data:: _PDF_CSS_ASSETS

.. py:function:: _pdf_page_css(style: str) -> str

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


.. py:function:: _replace_device_doc_label(file_path: pathlib.Path, module_name: str) -> None

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


.. py:function:: _prepare_markdown_for_pdf(markdown_text: str, style: str) -> str

   Normalize markdown so md2pdf renders parameter lists reliably.


.. py:function:: _discover_modules_from_init(device_root: pathlib.Path) -> list[str]

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


.. py:function:: _infer_default_module_name(device_root: pathlib.Path) -> str | None

   Infer a sensible default import module from device root contents.


.. py:function:: 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).


.. py:function:: manual_command() -> None

   Generate and manage external device manuals.