test_docs
=========

.. py:module:: test_docs

.. autoapi-nested-parse::

   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 ``<!-- excerpt -->`` comment is quoted from a bench and is not meant to run
   on its own, so it is skipped.



Attributes
----------

.. autoapisummary::

   test_docs.DOCS
   test_docs.PAGES
   test_docs.FENCE


Functions
---------

.. autoapisummary::

   test_docs._runs
   test_docs.test_the_docs_pages_are_found
   test_docs.test_the_page_runs_as_written


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

.. py:data:: DOCS

.. py:data:: PAGES

.. py:data:: FENCE

.. py:function:: _runs(page: pathlib.Path) -> list[tuple[str, str | None]]

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


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

.. py:function:: test_the_page_runs_as_written(page: pathlib.Path) -> None