gdtest_homepage_ug — Synthetic Package Details

#215 gdtest_homepage_ug OK CONFIG

Blended user-guide homepage mode (homepage: user_guide)

Blended user-guide homepage mode (homepage: user_guide). The first user guide page becomes index.qmd with the metadata sidebar. No separate 'User Guide' navbar link is generated.

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

A1 B1 C1 D1 E6 F1 G7 H7

A1Flat layoutlayout

B1Explicit __all__exports

C1Functions onlyobjects

D1NumPydocstrings

E6No directivesdirectives

F1Auto-discoveruser_guide

G7Blended UG homepagelanding

H7No extrasextras

Source Files

📁 gdtest_homepage_ug/

📄 __init__.py

"""A test package for blended homepage mode."""

__version__ = "0.1.0"
__all__ = ["greet", "farewell"]


def greet(name: str) -> str:
    """
    Greet someone.

    Parameters
    ----------
    name
        The name to greet.

    Returns
    -------
    str
        A greeting string.
    """
    return f"Hello, {name}!"


def farewell(name: str) -> str:
    """
    Say farewell to someone.

    Parameters
    ----------
    name
        The name to bid farewell.

    Returns
    -------
    str
        A farewell string.
    """
    return f"Goodbye, {name}!"

📁 user_guide/

📄 00-getting-started.qmd

---
title: Getting Started
---

# Getting Started

Welcome to the project! This is the first user guide page and will
become the site landing page in blended homepage mode.

## Installation

Install with pip:

```bash
pip install gdtest-homepage-ug
```

📄 01-configuration.qmd

---
title: Configuration
---

# Configuration

Learn how to configure the package.

## Basic Setup

Create a config file and set your options.

📄 02-advanced.qmd

---
title: Advanced Usage
---

# Advanced Usage

Explore advanced topics and customization.

📄 README.md

# gdtest-homepage-ug

A synthetic test package for blended homepage mode.

📄 great-docs.yml

homepage: user_guide