bundle.docs.discovery

Attributes

log

Functions

discover_project(→ dict)	Read pyproject.toml and return project metadata and package layout.
find_readme_files(→ list[pathlib.Path])	Recursively find all README.md files in the package tree.
find_subpackages(→ list[str])	Find all Python subpackages (directories with __init__.py).

Module Contents

bundle.docs.discovery.log

bundle.docs.discovery.discover_project(source_dir: pathlib.Path) → dict

Read pyproject.toml and return project metadata and package layout.

Parameters:

source_dir – Project root directory containing pyproject.toml.

Returns:

name, version, author, package_dirs.

Return type:

Dictionary with keys

bundle.docs.discovery.find_readme_files(package_root: pathlib.Path) → list[pathlib.Path]

Recursively find all README.md files in the package tree.

Parameters:

package_root – Root directory of the Python package.

Returns:

Sorted list of README.md paths found.

bundle.docs.discovery.find_subpackages(package_root: pathlib.Path) → list[str]

Find all Python subpackages (directories with __init__.py).

Parameters:

package_root – Root directory of the Python package.

Returns:

Sorted list of subpackage names.