gdtest-config-exclude

A synthetic test package testing config-based exclusion.

All four exports are in all, but great-docs.yml excludes helper_func and InternalClass. On the Reference page you should see only PublicAPI and transform — the excluded items must be absent. The key test: config-level exclusion via the exclude list in great-docs.yml.

Source files

📁 gdtest_config_exclude/

📄 __init__.py

"""A test package with config-level exclusions."""

__version__ = "0.1.0"
__all__ = ["PublicAPI", "transform", "helper_func", "InternalClass"]


class PublicAPI:
    """
    The main public API class.

    Parameters
    ----------
    name
        API name.
    """

    def __init__(self, name: str):
        self.name = name

    def call(self) -> str:
        """
        Call the API.

        Returns
        -------
        str
            API response.
        """
        return f"response from {self.name}"


class InternalClass:
    """
    An internal class excluded via config.

    This should NOT appear in documentation.
    """

    def __init__(self):
        pass


def transform(data: str) -> str:
    """
    Transform data.

    Parameters
    ----------
    data
        Input data.

    Returns
    -------
    str
        Transformed data.
    """
    return data.upper()


def helper_func() -> None:
    """
    A helper function excluded via config.

    This should NOT appear in documentation.
    """
    pass

📄 README.md

# gdtest-config-exclude

A synthetic test package testing config-based exclusion.

📄 great-docs.yml

exclude:
  - helper_func
  - InternalClass