io¶

class PlayMemo(contents: bytes, suffix: str)¶

Bases: object

For renderables that need to be captured during Sphinx output, e.g. realtime buffers.

A realtime buffer does not exist by the time Sphinx writes output, so we capture the state of the buffer during Sphinx’s read pass as a memo, and render the memo as audio during the write pass.

__render__(output_file_path: PathLike | None = None, render_directory_path: PathLike | None = None, **kwargs) → Coroutine[None, None, tuple[Path | None, int]]¶

__replace__(**changes)¶

classmethod from_path(path: Path) → PlayMemo¶

class Player(renderable: SupportsRender, **kwargs)¶

Bases: object

__call__() → tuple[Path | None, int]¶

Call self as a function.

open_output_path(output_path) → None¶

render() → tuple[Path | None, int]¶

class Plotter(plottable: SupportsPlot, **kwargs)¶

Bases: object

__call__()¶

Call self as a function.

open_output_path(output_path)¶

render()¶

graph(graphable, format_='pdf', layout='dot')¶

play(renderable: SupportsRender, **kwargs)¶

plot(plottable: SupportsPlot, format_='png', **kwargs)¶

render(renderable: SupportsRender | SupportsRenderMemo, output_file_path: PathLike | None = None, render_directory_path: PathLike | None = None, **kwargs) → tuple[Path | None, int]¶