test_docs

Every python block in the tutorials runs as written, in order.

The tutorials are the pages that promise to work without a board, against the fake transport, so they are the ones run here; the how-to and reference pages show fragments for a real device. A page is one session: its blocks share a namespace, the way a reader typing them into one prompt would, and it runs in a scratch directory. Where a page shows what a block prints (an untagged or text fence right after it, with at most a lead-in line such as “Output:” between), the output must match. A block marked with an <!-- excerpt --> comment is skipped.

Attributes

DOCS
PAGES
FENCE
LEAD_IN

Functions

_runs(page) → list[tuple[str, str | None]]	The page's runnable python blocks, each with the output shown after it.
test_the_tutorials_are_found_and_check_output() → None
test_the_page_runs_as_written(page, tmp_path, monkeypatch) → None

Module Contents

test_docs.DOCS

test_docs.PAGES

test_docs.FENCE

test_docs.LEAD_IN

test_docs._runs(page: pathlib.Path) → list[tuple[str, str | None]]

The page’s runnable python blocks, each with the output shown after it.

test_docs.test_the_tutorials_are_found_and_check_output() → None

test_docs.test_the_page_runs_as_written(page: pathlib.Path, tmp_path, monkeypatch) → None