gdtest_homepage_ug_subdirs — Synthetic Package Details

#274 gdtest_homepage_ug_subdirs OK CONFIG

Blended homepage: user_guide with subdirectory structure + section with asset directories

Combines homepage: user_guide with a user guide that has subdirectories (root index.qmd + 00-getting-started/ + 01-advanced/) and a custom Examples section whose source dir contains asset subdirectories (data/, img/). Tests three fixes: (1) root index.qmd sorts first despite numbered files in subdirs, (2) blended index locates the first page using the full relative path, (3) section asset directories are copied to the build directory.

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

G7 M4 N1

G7Blended UG homepagelanding

M4Subdirectory UGuser_guide

N1Examples sectionsections

Source Files

📁 examples/

📁 data/

📄 sample.csv

name,value
alpha,1
beta,2
gamma,3

📁 img/

📄 diagram.txt

placeholder-diagram-content

📄 01-basic-usage.qmd

---
title: Basic Usage
---

# Basic Usage

A simple example reading data from a local file.

The data file is located at `../data/sample.csv`.

📄 02-advanced-patterns.qmd

---
title: Advanced Patterns
---

# Advanced Patterns

An advanced example using images and data.

![Diagram](../img/diagram.txt)

📁 gdtest_homepage_ug_subdirs/

📄 __init__.py

"""A test package for blended homepage with subdir user guide."""

__version__ = "0.1.0"
__all__ = ["process", "analyze"]


def process(data: list) -> list:
    """
    Process a list of data items.

    Parameters
    ----------
    data
        The input data to process.

    Returns
    -------
    list
        The processed data.
    """
    return [x * 2 for x in data]


def analyze(data: list) -> dict:
    """
    Analyze a list of data items.

    Parameters
    ----------
    data
        The input data to analyze.

    Returns
    -------
    dict
        Analysis results.
    """
    return {"count": len(data), "sum": sum(data)}

📁 user_guide/

📁 00-getting-started/

📄 01-quickstart.qmd

---
title: Quickstart
---

# Quickstart

Get up and running in minutes.

```python
from gdtest_homepage_ug_subdirs import process
result = process([1, 2, 3])
```

📄 index.qmd

---
title: Getting Started
---

# Getting Started

This section covers installation and basic setup.

📁 01-advanced/

📄 01-analysis.qmd

---
title: Analysis
---

# Analysis

Learn how to use the analyze function for data insights.

📄 index.qmd

---
title: Welcome
---

# Welcome

Welcome to the project documentation! This root index page should
become the site landing page in blended homepage mode.

## Overview

This project provides data processing and analysis utilities.

📄 README.md

# gdtest-homepage-ug-subdirs

Test blended homepage with subdir UG and section assets.

📄 great-docs.yml

homepage: user_guide
sections:
  - title: Examples
    dir: examples