gdtest_overloads — Synthetic Package Details

#060 gdtest_overloads OK INIT

Functions with @overload signatures

Module using @overload from typing: process() has three overloads (str→str, int→int, list→list) plus the implementation. On the Reference page you should ideally see the overloaded signatures. At minimum, the function must render without errors.

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

A1 B1 C15 D1 E6 F6 G1 H7

A1Flat layoutlayout

B1Explicit __all__exports

C15Overloaded functionsobjects

D1NumPydocstrings

E6No directivesdirectives

F6No user guideuser_guide

G1README.mdlanding

H7No extrasextras

Source Files

📁 gdtest_overloads/

📄 __init__.py

"""Package with @overload decorated functions."""

from typing import overload, Union

__version__ = "0.1.0"
__all__ = ["process", "convert", "transform"]


@overload
def process(data: str) -> str: ...

@overload
def process(data: int) -> int: ...

@overload
def process(data: list) -> list: ...

def process(data):
    """
    Process data of varying types.

    Parameters
    ----------
    data
        Input data — can be str, int, or list.

    Returns
    -------
    str or int or list
        Processed output, same type as input.
    """
    return data


@overload
def convert(value: str, to: type) -> int: ...

@overload
def convert(value: int, to: type) -> str: ...

def convert(value, to=str):
    """
    Convert a value to a different type.

    Parameters
    ----------
    value
        The value to convert.
    to
        Target type.

    Returns
    -------
    int or str
        Converted value.
    """
    return to(value)


def transform(data, mode="upper"):
    """
    Transform data with a given mode.

    This function applies a transformation. Example::

        result = transform("hello", mode="upper")
        print(result)

    You can also chain transformations::

        step1 = transform("hello", mode="upper")
        step2 = transform(step1, mode="reverse")

    Parameters
    ----------
    data
        The input data to transform.
    mode
        Transformation mode (``"upper"``, ``"lower"``, or ``"reverse"``).

    Returns
    -------
    str
        The transformed string.
    """
    if mode == "upper":
        return str(data).upper()
    elif mode == "lower":
        return str(data).lower()
    elif mode == "reverse":
        return str(data)[::-1]
    return str(data)

📄 README.md

# gdtest-overloads

Tests documentation of @overload decorated functions.

📄 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:
      - convert
      - 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