gdtest_constants — Synthetic Package Details

#027 gdtest_constants OK INIT

Constants and type aliases

Five exports: three constants (DEFAULT_TIMEOUT, MAX_RETRIES, SUPPORTED_FORMATS), one type alias (HandlerFunc), and one function (process). On the Reference page you should see both constants and the function listed. Constants should show their values and type annotations.

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 C12 D1 E6 F6 G1 H7

A1Flat layoutlayout

B1Explicit __all__exports

C12Constants/aliasesobjects

D1NumPydocstrings

E6No directivesdirectives

F6No user guideuser_guide

G1README.mdlanding

H7No extrasextras

Source Files

📁 gdtest_constants/

📄 __init__.py

"""A test package with constants and type aliases."""

__version__ = "0.1.0"
__all__ = [
    "DEFAULT_TIMEOUT",
    "MAX_RETRIES",
    "SUPPORTED_FORMATS",
    "HandlerFunc",
    "process",
]

from typing import Callable

DEFAULT_TIMEOUT: int = 30
"""Default timeout in seconds for network operations."""

MAX_RETRIES: int = 3
"""Maximum number of retry attempts."""

SUPPORTED_FORMATS: list[str] = ["json", "csv", "xml"]
"""List of supported output formats."""

HandlerFunc = Callable[..., None]
"""Type alias for event handler functions."""


def process(data: str, timeout: int = DEFAULT_TIMEOUT) -> str:
    """
    Process data with a timeout.

    Parameters
    ----------
    data
        The input data.
    timeout
        Timeout in seconds.

    Returns
    -------
    str
        Processed data.
    """
    return data

📄 README.md

# gdtest-constants

A synthetic test package with constants and type aliases.

📄 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

  - title: Constants
    desc: Module-level constants and data
    contents:
      - DEFAULT_TIMEOUT
      - MAX_RETRIES
      - SUPPORTED_FORMATS

# 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