gdtest-explicit-big-class

Tests explicit reference with members=false on a big class.

Explicit reference config with a big class. Config defines sections ‘Core’ with BigEngine (members: false) and ‘Helpers’ with helper_a, helper_b. On the Reference page BigEngine should appear WITHOUT its methods listed (members: false suppresses them), and there should be NO separate ‘BigEngine Methods’ subsection.

Source files

📁 gdtest_explicit_big_class/

📄 __init__.py

"""Package with explicit reference and big class."""

__version__ = "0.1.0"
__all__ = ["BigEngine", "helper_a", "helper_b"]


class BigEngine:
    """
    A complex engine with many methods.

    Parameters
    ----------
    config
        Configuration dictionary.
    """

    def __init__(self, config: dict):
        self.config = config

    def start(self) -> None:
        """Start the engine."""
        pass

    def stop(self) -> None:
        """Stop the engine."""
        pass

    def restart(self) -> None:
        """Restart the engine."""
        pass

    def configure(self, key: str, value) -> None:
        """
        Configure a setting.

        Parameters
        ----------
        key
            Setting key.
        value
            Setting value.
        """
        pass

    def status(self) -> str:
        """
        Get engine status.

        Returns
        -------
        str
            Status string.
        """
        return "running"

    def metrics(self) -> dict:
        """
        Get performance metrics.

        Returns
        -------
        dict
            Metrics dictionary.
        """
        return {}

    def health_check(self) -> bool:
        """
        Run health check.

        Returns
        -------
        bool
            True if healthy.
        """
        return True


def helper_a(x: int) -> int:
    """
    Helper function A.

    Parameters
    ----------
    x
        Input value.

    Returns
    -------
    int
        Processed value.
    """
    return x + 1


def helper_b(x: int) -> int:
    """
    Helper function B.

    Parameters
    ----------
    x
        Input value.

    Returns
    -------
    int
        Processed value.
    """
    return x * 2

📄 README.md

# gdtest-explicit-big-class

Tests explicit reference with members=false on a big class.

📄 great-docs.yml

reference:
  - title: Core
    members:
      - name: BigEngine
        members: false
  - title: Helpers
    members:
      - helper_a
      - helper_b