sphinx_polyversion.builder

Abstract Building framework.

Classes

Builder()

Base class for builders creating a documentation from source files.

Exceptions

BuildError

Building a specific version failed.
exception sphinx_polyversion.builder.BuildError[source]

Bases: Exception

Building a specific version failed.

class sphinx_polyversion.builder.Builder[source]

Bases: Generic[ENV, R]

Base class for builders creating a documentation from source files.

abstract async build(environment: ENV, output_dir: Path, data: None | bool | int | float | str | List[None | bool | int | float | str | List[JSONable] | Tuple[JSONable, ...] | Dict[None | bool | int | float | str, JSONable] | Transformable] | Tuple[None | bool | int | float | str | List[JSONable] | Tuple[JSONable, ...] | Dict[None | bool | int | float | str, JSONable] | Transformable, ...] | Dict[None | bool | int | float | str, None | bool | int | float | str | List[JSONable] | Tuple[JSONable, ...] | Dict[None | bool | int | float | str, JSONable] | Transformable] | Transformable) → R

Build and render a documentation.

This method should actually carry out the work of building and rendering a documentation.

Parameters:

  • environment (Environment) – The environment to use for building.

  • output_dir (Path) – The output directory to build to.

  • data (JSONable) – The metadata to use for building.

Returns:

Arbitrary data that results from building. This data can be used by custom Driver implementations.

Return type:

Any