gdtest_ug_numbered — Synthetic Package Details

#150 gdtest_ug_numbered OK INIT

Numbered user guide with 4 sequentially named .qmd files.

Numbered user guide files: 01-intro.qmd, 02-install.qmd, 03-usage.qmd, 04-advanced.qmd. Should appear in numeric order in the sidebar.

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

M2Numbered UG filesuser_guide

Source Files

📁 gdtest_ug_numbered/

📄 __init__.py

"""Test package for numbered user guide."""

📄 core.py

"""Core run/status functions."""


def run(task: str) -> str:
    """Run a named task.

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

    Returns
    -------
    str
        A message indicating task completion.

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


def status() -> dict:
    """Return the current status of all tasks.

    Returns
    -------
    dict
        A dictionary mapping task names to their status.

    Examples
    --------
    >>> status()
    {'build': 'idle'}
    """
    return {"build": "idle"}

📁 user_guide/

📄 01-intro.qmd

---
title: Introduction
---

# Introduction

Welcome to the introduction guide.

📄 02-install.qmd

---
title: Installation
---

# Installation

How to install the package.

📄 03-usage.qmd

---
title: Usage
---

# Usage

How to use the package effectively.

📄 04-advanced.qmd

---
title: Advanced
---

# Advanced

Advanced usage patterns and techniques.

📄 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

# Exclusions
# ----------
# Items to exclude from auto-documentation (affects 'init' and 'scan')
# 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

# 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

# API Reference Structure
# -----------------------
# Auto-discovery couldn't determine your package's public API.
# You can manually specify which items to document here.
#
# Uncomment and customize the reference section below:
#
# reference:
#   - title: Functions
#     desc: Public functions provided by the package
#     contents:
#       - my_function
#       - another_function
#
#   - title: Classes
#     desc: Main classes for working with the package
#     contents:
#       - name: MyClass
#         members: false       # Don't document methods inline
#       - SimpleClass          # Methods documented inline (default)
#
# After editing, run 'great-docs build' to generate your documentation.