test_docs¶

Every python block on the documentation pages runs as written, in order.

A page is one session: its blocks share a namespace, the way a reader typing them into one prompt would. Where a page shows what a block prints (an untagged fence directly after it), the output must match. A block marked with an  comment is quoted from a bench and is not meant to run on its own, so it is skipped.

Attributes¶

`DOCS`
`PAGES`
`FENCE`

Functions¶

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

Module Contents¶

test_docs.DOCS¶

test_docs.PAGES¶

test_docs.FENCE¶

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_docs_pages_are_found() → None¶

test_docs.test_the_page_runs_as_written(page: pathlib.Path) → None¶