Skip to content

Config

Configuration loading from pyproject.toml for click-docs.

FUNCTION DESCRIPTION
find_config

Searches for a 'pyproject.toml' file starting from a given directory and traversing up the directory tree.

Functions

find_config

find_config(start: Path | None = None) -> dict[str, Any]

Searches for a 'pyproject.toml' file starting from a given directory and traversing up the directory tree.

If found, the configuration file is read and returned as a dictionary. If no configuration file is found, an empty dictionary is returned.

PARAMETER DESCRIPTION
start

Starting directory path to begin the search for 'pyproject.toml'. If None, the current working directory is used.

TYPE: Path | None DEFAULT: None

RETURNS DESCRIPTION
dict[str, Any]

A dictionary containing the configuration data parsed from 'pyproject.toml'. Returns an empty

dict[str, Any]

dictionary if no configuration file is located.