gdtest_config_combo_c — Synthetic Package Details

#118 gdtest_config_combo_c OK CONFIG

Config combo: sections with examples and tutorials, user_guide as explicit list, reference with explicit sections. Full navigation structure.

Combination: sections (examples + tutorials) + user_guide (list) + reference (explicit). Full navigation structure defined by config.

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

K18 K20 K22

K18sections configconfig

K20user_guide: listconfig

K22reference configconfig

Source Files

📁 examples/

📄 demo.qmd

---
title: Demo Example
---

# Demo

A demonstration of the package in action.

📁 gdtest_config_combo_c/

📄 __init__.py

"""Test package for config combo C."""

from gdtest_config_combo_c.pipeline import build, deploy
from gdtest_config_combo_c.ops import test, monitor

📄 ops.py

"""Testing and monitoring operations."""


def test(suite: str = "unit") -> dict:
    """Run the specified test suite.

    Parameters
    ----------
    suite : str, optional
        The name of the test suite to run, by default "unit".

    Returns
    -------
    dict
        A dictionary containing test results with passed and
        failed counts.

    Examples
    --------
    >>> test("integration")
    {'suite': 'integration', 'passed': 10, 'failed': 0}
    """
    return {"suite": suite, "passed": 10, "failed": 0}


def monitor(service: str, interval: int = 60) -> dict:
    """Monitor a service at the given interval.

    Parameters
    ----------
    service : str
        The name of the service to monitor.
    interval : int, optional
        The monitoring interval in seconds, by default 60.

    Returns
    -------
    dict
        A dictionary containing the service status and uptime.

    Examples
    --------
    >>> monitor("api", interval=30)
    {'service': 'api', 'status': 'healthy', 'interval': 30}
    """
    return {"service": service, "status": "healthy", "interval": interval}

📄 pipeline.py

"""Build and deployment pipeline functions."""


def build(target: str = "all") -> dict:
    """Build the project for the specified target.

    Parameters
    ----------
    target : str, optional
        The build target, by default "all".

    Returns
    -------
    dict
        A dictionary containing the build status and artifacts.

    Examples
    --------
    >>> build("docs")
    {'status': 'success', 'target': 'docs'}
    """
    return {"status": "success", "target": target}


def deploy(environment: str, dry_run: bool = False) -> str:
    """Deploy the project to the specified environment.

    Parameters
    ----------
    environment : str
        The target environment (e.g., "staging", "production").
    dry_run : bool, optional
        If True, simulate the deployment without making changes,
        by default False.

    Returns
    -------
    str
        A message indicating the deployment result.

    Examples
    --------
    >>> deploy("staging", dry_run=True)
    'Dry run: would deploy to staging'
    """
    if dry_run:
        return f"Dry run: would deploy to {environment}"
    return f"Deployed to {environment}"

📁 tutorials/

📄 step1.qmd

---
title: Step 1 - Getting Started
---

# Step 1

The first step in the tutorial.

📁 user_guide/

📄 advanced.qmd

---
title: Advanced Topics
---

# Advanced Topics

In-depth coverage of advanced features.

📄 intro.qmd

---
title: Introduction
---

# Introduction

Welcome to the user guide.

📄 great-docs.yml

sections:
  - title: Examples
    dir: examples
  - title: Tutorials
    dir: tutorials
user_guide:
  - title: Basics
    contents:
      - intro.qmd
  - title: Advanced Topics
    contents:
      - advanced.qmd
reference:
  - title: Build Pipeline
    desc: Build and deployment functions
    contents:
      - name: build
      - name: deploy
  - title: Operations
    desc: Testing and monitoring functions
    contents:
      - name: test
      - name: monitor