gdtest_config_ug_list — Synthetic Package Details

#113 gdtest_config_ug_list OK CONFIG

Tests user_guide config as an explicit list of section dicts with titles and contents.

Tests user_guide as explicit list of sections with pages. Config defines exact ordering: 'Getting Started' (install, quickstart) then 'Advanced' (customization). Sidebar should show this structure.

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

K20

K20user_guide: listconfig

Source Files

📁 gdtest_config_ug_list/

📄 __init__.py

"""Test package for user_guide list config."""

📄 core.py

"""Core setup and run functions."""


def setup(config: dict) -> None:
    """Set up the application with the given configuration.

    Parameters
    ----------
    config : dict
        A dictionary containing configuration options.

    Examples
    --------
    >>> setup({"debug": True})
    """
    pass


def run(task: str) -> str:
    """Run a named task and return the result.

    Parameters
    ----------
    task : str
        The name of the task to execute.

    Returns
    -------
    str
        The result of executing the task.

    Examples
    --------
    >>> run("build")
    'build complete'
    """
    return f"{task} complete"

📁 user_guide/

📄 customization.qmd

---
title: Customization
---

# Customization

Advanced customization options.

📄 install.qmd

---
title: Installation
---

# Installation

How to install the package.

📄 quickstart.qmd

---
title: Quickstart
---

# Quickstart

Get started quickly with this guide.

📄 great-docs.yml

user_guide:
  - title: Getting Started
    contents:
      - install.qmd
      - quickstart.qmd
  - title: Advanced
    contents:
      - customization.qmd