Links

View on PyPI

AI / Agents

Skills
llms.txt
llms-full.txt

gdtest-ref-members-false

Test reference config with members: false.

Reference config with members: false on a class. The class should appear but its methods should NOT be listed separately.

Source files

📁 gdtest_ref_members_false/

📄 __init__.py

"""Test package for reference config with members: false."""

from .core import Engine, start_engine

__all__ = ["Engine", "start_engine"]

📄 core.py

"""Core Engine class and start_engine function."""


class Engine:
    """A configurable engine for processing tasks.

    Parameters
    ----------
    name : str
        The name of the engine.

    Examples
    --------
    >>> e = Engine("turbo")
    >>> e.status()
    'idle'
    """

    def __init__(self, name: str):
        """Initialize the engine.

        Parameters
        ----------
        name : str
            The name of the engine.
        """
        self.name = name
        self._running = False

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

        Returns
        -------
        None
        """
        self._running = True

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

        Returns
        -------
        None
        """
        self._running = False

    def restart(self) -> None:
        """Restart the engine by stopping and starting it.

        Returns
        -------
        None
        """
        self.stop()
        self.start()

    def status(self) -> str:
        """Return the current status of the engine.

        Returns
        -------
        str
            Either 'running' or 'idle'.
        """
        return "running" if self._running else "idle"

    def configure(self, options: dict) -> None:
        """Configure the engine with the given options.

        Parameters
        ----------
        options : dict
            A dictionary of configuration options.

        Returns
        -------
        None
        """
        self._options = options


def start_engine(config: dict) -> "Engine":
    """Create and start an engine with the given configuration.

    Parameters
    ----------
    config : dict
        A dictionary of engine configuration options.

    Returns
    -------
    Engine
        A running Engine instance.

    Examples
    --------
    >>> engine = start_engine({"name": "main"})
    >>> engine.status()
    'running'
    """
    engine = Engine(config.get("name", "default"))
    engine.start()
    return engine

📄 README.md

# gdtest-ref-members-false

Test reference config with members: false.

📄 great-docs.yml

reference:
  - title: Core
    desc: Core API
    contents:
      - name: Engine
        members: false
      - name: start_engine