dev.docs.nbs

Documentation utilities.

Module Contents

Functions

init	Initialize a documentation notebook.
get_mode	Get notebook mode.
nowarn	Don’t raise any warnings. Optionally capture output for pesky warnings.
keep_viewer_in_scope	Keep the image viewer in scope so it doesn’t get garbage collected.

API

dev.docs.nbs.init(

mode: dev.docs.types.BuildMode | None = None,

) → boilercv_pipeline.models.contexts.BoilercvPipelineContexts

Initialize a documentation notebook.

dev.docs.nbs.get_mode() → dev.docs.types.BuildMode

Get notebook mode.

dev.docs.nbs.nowarn(

capture: bool = False,

)

Don’t raise any warnings. Optionally capture output for pesky warnings.

dev.docs.nbs.keep_viewer_in_scope()

Keep the image viewer in scope so it doesn’t get garbage collected.