bundle.docs.config

Attributes

log

Classes

DocsConfig

Configuration for a Sphinx documentation build.

Module Contents

bundle.docs.config.log

class bundle.docs.config.DocsConfig(/, **data: Any)

Bases: bundle.core.data.Data

Configuration for a Sphinx documentation build.

project_name: str = 'TheBundle'

project_version: str = ''

author: str = ''

source_dir: pathlib.Path = None

output_dir: pathlib.Path = None

package_dirs: list[str] = None

autoapi_dirs: list[str] = None

theme: str = 'furo'

include_readmes: bool = True

extensions: list[str] = None

generate_conf_py() → str

Render a complete Sphinx conf.py as a string.