bundle.docs.discovery
=====================

.. py:module:: bundle.docs.discovery


Attributes
----------

.. autoapisummary::

   bundle.docs.discovery.log


Functions
---------

.. autoapisummary::

   bundle.docs.discovery.discover_project
   bundle.docs.discovery.find_readme_files
   bundle.docs.discovery.find_subpackages


Module Contents
---------------

.. py:data:: log

.. py:function:: discover_project(source_dir: pathlib.Path) -> dict

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

   :param source_dir: Project root directory containing pyproject.toml.

   :returns: name, version, author, package_dirs.
   :rtype: Dictionary with keys


.. py:function:: find_readme_files(package_root: pathlib.Path) -> list[pathlib.Path]

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

   :param package_root: Root directory of the Python package.

   :returns: Sorted list of README.md paths found.


.. py:function:: find_subpackages(package_root: pathlib.Path) -> list[str]

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

   :param package_root: Root directory of the Python package.

   :returns: Sorted list of subpackage names.