Tester APIs

class sphinx_ape.testing.DocumentationTester(base_path: Path | None = None, name: str | None = None, toc_tree_spec: TOCTreeSpec | None = None)

Small wrapper around sphinx-build’s doctest command.

property doctest_folder: Path

The path to doctest’s build folder.

property doctest_output_file: Path

The path to doctest’s output file.

test()

Run the sphinx-build doctest command.

Raises:

ApeDocsTestError –