gdtest_sec_index_opt — Synthetic Package Details

#174 gdtest_sec_index_opt OK CONFIG

Sections with and without auto-generated index pages.

Section index opt-in: Examples section with index: true gets a card-based index page; Tutorials section without index (default) has navbar linking directly to the first page.

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

N8Section index opt-insections

Source Files

📁 examples/

📄 advanced-patterns.qmd

---
title: Advanced Patterns
description: Explore advanced usage patterns and techniques.
---

# Advanced Patterns

This example covers advanced patterns.

```python
from gdtest_sec_index_opt import transform
result = transform('hello world', upper=True)
```

📄 basic-usage.qmd

---
title: Basic Usage
description: Learn the fundamentals of the package.
---

# Basic Usage

This example covers the basic usage of the package.

```python
from gdtest_sec_index_opt import analyze
result = analyze([10, 20, 30])
print(result)
```

📄 real-world.qmd

---
title: Real-World Scenario
description: A complete real-world example with data analysis.
---

# Real-World Scenario

Putting it all together in a real-world scenario.

📁 gdtest_sec_index_opt/

📄 __init__.py

"""Test package for section index opt-in."""

from .core import analyze, transform

__all__ = ["analyze", "transform"]

📄 core.py

"""Core analyze/transform functions."""


def analyze(data: list) -> dict:
    """Analyze the given data and return summary statistics.

    Parameters
    ----------
    data : list
        A list of numeric values to analyze.

    Returns
    -------
    dict
        A dictionary with summary statistics.

    Examples
    --------
    >>> analyze([1, 2, 3])
    {'mean': 2.0, 'count': 3}
    """
    return {"mean": sum(data) / len(data), "count": len(data)}


def transform(value: str, upper: bool = False) -> str:
    """Transform a string value.

    Parameters
    ----------
    value : str
        The string to transform.
    upper : bool
        Whether to convert to upper case.

    Returns
    -------
    str
        The transformed string.

    Examples
    --------
    >>> transform("hello", upper=True)
    'HELLO'
    """
    return value.upper() if upper else value.lower()

📁 tutorials/

📄 best-practices.qmd

---
title: Best Practices
description: Tips and best practices for production use.
---

# Best Practices

Follow these best practices for production deployments.

📄 data-processing.qmd

---
title: Data Processing
description: Learn how to process data efficiently.
---

# Data Processing

In this tutorial you will learn to process data.

📄 getting-started.qmd

---
title: Getting Started
description: Your first steps with the package.
---

# Getting Started

Welcome! This tutorial walks you through your first steps.

📄 README.md

# gdtest-sec-index-opt

Test package demonstrating section index opt-in behavior.

📄 great-docs.yml

sections:
  - title: Examples
    dir: examples
    index: true
  - title: Tutorials
    dir: tutorials