gdtest_src_explicit_ref — Synthetic Package Details

#057 gdtest_src_explicit_ref OK CONFIG

src/ layout with explicit reference configuration

src/ layout (A2) with explicit reference config. Config defines two sections: 'Core' (Engine, run) and 'Utils' (format_result). Module lives in src/. On the Reference page you should see exactly 'Core' and 'Utils' headings. Key test: explicit ref + src/ layout together.

View Site → Build Log 🧪 Test Coverage

Build Mode

● Has great-docs.yml

This package ships a pre-supplied config. The great-docs init step is skipped and great-docs build uses the spec-defined configuration directly. Tests specific config options and their rendered output.

Dimensions

A2 B1 C4 D1 E6 F6 G1 H7

A2src/ layoutlayout

B1Explicit __all__exports

C4Mixed class+funcobjects

D1NumPydocstrings

E6No directivesdirectives

F6No user guideuser_guide

G1README.mdlanding

H7No extrasextras

Source Files

📁 src/

📁 gdtest_src_explicit_ref/

📄 __init__.py

"""Package in src/ with explicit reference config."""

__version__ = "0.1.0"
__all__ = ["Engine", "run", "format_result"]


class Engine:
    """
    Core processing engine.

    Parameters
    ----------
    name
        Engine name.
    """

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

    def execute(self) -> dict:
        """
        Execute the engine.

        Returns
        -------
        dict
            Results.
        """
        return {}


def run(engine: Engine) -> dict:
    """
    Run an engine instance.

    Parameters
    ----------
    engine
        The engine to run.

    Returns
    -------
    dict
        Run results.
    """
    return engine.execute()


def format_result(result: dict) -> str:
    """
    Format an engine result for display.

    Parameters
    ----------
    result
        Result dictionary.

    Returns
    -------
    str
        Formatted string.
    """
    return str(result)

📄 README.md

# gdtest-src-explicit-ref

Tests src/ layout with explicit reference configuration.

📄 great-docs.yml

reference:
  - title: Core
    contents:
      - Engine
      - run
  - title: Utility
    contents:
      - format_result