gdtest_ug_with_code — Synthetic Package Details

#160 gdtest_ug_with_code OK INIT

User guide pages with fenced Python code blocks.

User guide pages containing Python code blocks, both fenced and executable. Code should be syntax-highlighted.

View Site → Build Log 🧪 Test Coverage

Build Mode

○ No great-docs.yml

This package has no pre-supplied config. It tests the full great-docs init → great-docs build pipeline from scratch, relying entirely on auto-detection of the package layout, docstring style, and exports.

Dimensions

M12

M12UG with code blocksuser_guide

Source Files

📁 gdtest_ug_with_code/

📄 __init__.py

"""Test package for user guide with code blocks."""

from .core import process, transform

__all__ = ["process", "transform"]

📄 core.py

"""Core process/transform functions."""


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

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

    Returns
    -------
    list
        The processed data.

    Examples
    --------
    >>> process([1, 2, 3])
    [2, 4, 6]
    """
    return [x * 2 for x in data]


def transform(data: dict) -> dict:
    """Transform a dictionary of data.

    Parameters
    ----------
    data : dict
        The input dictionary to transform.

    Returns
    -------
    dict
        The transformed dictionary.

    Examples
    --------
    >>> transform({"key": "value"})
    {'key': 'VALUE'}
    """
    return {k: v.upper() if isinstance(v, str) else v for k, v in data.items()}

📁 user_guide/

📄 tutorial.qmd

---
title: Tutorial
---

# Getting Started

Here's a basic example that runs and prints output:

```{python}
from gdtest_ug_with_code.core import process

result = process([1, 2, 3])
print(result)
```

And a fenced (non-executable) code block showing a transform:

```python
from gdtest_ug_with_code.core import transform

data = {"key": "value"}
output = transform(data)
print(output)  # {'key': 'VALUE'}
```

📄 README.md

# gdtest-ug-with-code

Test user guide with Python code blocks.

📄 great-docs.yml generated

# Great Docs Configuration
# See https://posit-dev.github.io/great-docs/user-guide/configuration.html

# Module Name (optional)
# ----------------------
# Set this if your importable module name differs from the project name.
# Example: project 'py-yaml12' with module name 'yaml12'
# module: yaml12

# Docstring Parser
# ----------------
# The docstring format used in your package (numpy, google, or sphinx)
parser: numpy

# Dynamic Introspection
# ---------------------
# Use runtime introspection for more accurate documentation (default: true)
# Set to false if your package has cyclic alias issues (e.g., PyO3/Rust bindings)
dynamic: true

# API Discovery Settings
# ----------------------
# Exclude items from auto-documentation
# exclude:
#   - InternalClass
#   - helper_function

# Logo & Favicon
# ---------------
# Point to a single logo file (replaces the text title in the navbar):
# logo: assets/logo.svg
#
# For light/dark variants:
# logo:
#   light: assets/logo-light.svg
#   dark: assets/logo-dark.svg
#
# To show the text title alongside the logo, add: show_title: true

# Funding / Copyright Holder
# --------------------------
# Credit the organization that funds or holds copyright for this package.
# Displays in sidebar and footer. Homepage and ROR provide links.
# funding:
#   name: "Posit Software, PBC"
#   roles:
#     - Copyright holder
#     - funder
#   homepage: https://posit.co
#   ror: https://ror.org/03wc8by49

# API Reference Structure
# -----------------------
# Customize the sections below to organize your API documentation.
# - Reorder items within a section to change their display order
# - Move items between sections or create new sections
# - Use 'members: false' to exclude methods from documentation
# - Add 'desc:' to sections for descriptions

reference:
  - title: Functions
    desc: Utility functions
    contents:
      - process
      - transform

# Site URL
# --------
# Canonical address of the deployed documentation site.
# Required for subdirectory deployments, skills page install commands,
# .well-known/ discovery, and sitemaps.
# site_url: "https://your-org.github.io/your-package/"

# Site Settings
# -------------
# site:
#   theme: flatly              # Quarto theme (default: flatly)
#   toc: true                  # Show table of contents (default: true)
#   toc-depth: 2               # TOC heading depth (default: 2)
#   toc-title: On this page    # TOC title (default: "On this page")

# Jupyter Kernel
# --------------
# Jupyter kernel to use for executing code cells in .qmd files.
# This is set at the project level so it applies to all pages, including
# auto-generated API reference pages. Can be overridden in individual .qmd
# file frontmatter if needed for special cases.
jupyter: python3

# CLI Documentation
# -----------------
# cli:
#   enabled: true              # Enable CLI documentation
#   module: my_package.cli     # Module containing Click commands
#   name: cli                  # Name of the Click command object