zuke.tools.docs

← Python API reference

@zuke/docs 1.0.1: @zuke/docs — typed tasks that turn already-generated API documentation into agent-friendly artifacts, so neither humans nor agents have to guess an API.

zuke on PyPI ↗ 1 symbols

Symbols

#

DocsTasks

class 
class DocsTasks

Typed tasks for generating and verifying API documentation.

  • static async api_docs(ctx: ServiceContext, docs: Sequence[Mapping[str, object]], options: Mapping[str, object] | None=None) -> object

    From the supplied per-package docs, generate the index, the full reference, and (unless disabled) each package README's API block, writing only the files whose content changed. Returns the paths written.

  • static async check_api_docs(ctx: ServiceContext, docs: Sequence[Mapping[str, object]], options: Mapping[str, object] | None=None) -> object

    Recompute every artifact and return the paths that are out of date on disk (empty when everything is current). Writes nothing.

  • static async check_doc_lint(ctx: ServiceContext, reports: Sequence[Mapping[str, object]]) -> object

    Classify deno doc --lint output across packages into real defects: every missing-jsdoc, plus every private-type-ref whose referenced type is not an accepted cross-package import (in the report's crossPackageTypes). Fails safe — any other referenced type is treated as a first-party leak. Pure: the caller runs the linter; this classifies. Empty when clean.