gdtest-frozen-dc

Tests frozen dataclass documentation.

Frozen dataclass: @dataclass(frozen=True) with typed fields. Coordinate has x (float), y (float), label (str). On the Reference page you should see the class with its field signatures and defaults. Key test: frozen=True doesn’t break introspection.

Source files

📁 gdtest_frozen_dc/

📄 __init__.py

"""Package with frozen dataclasses."""

from dataclasses import dataclass, field

__version__ = "0.1.0"
__all__ = ["Coordinate", "BoundingBox"]


@dataclass(frozen=True)
class Coordinate:
    """
    An immutable 2D coordinate.

    Parameters
    ----------
    x
        X coordinate.
    y
        Y coordinate.
    label
        Optional label.
    """

    x: float
    y: float
    label: str = ""

    def distance_to(self, other: "Coordinate") -> float:
        """
        Calculate distance to another coordinate.

        Parameters
        ----------
        other
            The other coordinate.

        Returns
        -------
        float
            Euclidean distance.
        """
        return ((self.x - other.x) ** 2 + (self.y - other.y) ** 2) ** 0.5


@dataclass(frozen=True)
class BoundingBox:
    """
    An immutable bounding box defined by two corners.

    Parameters
    ----------
    min_corner
        Bottom-left corner.
    max_corner
        Top-right corner.
    """

    min_corner: Coordinate
    max_corner: Coordinate

    @property
    def width(self) -> float:
        """
        Width of the bounding box.

        Returns
        -------
        float
            Width.
        """
        return abs(self.max_corner.x - self.min_corner.x)

    @property
    def height(self) -> float:
        """
        Height of the bounding box.

        Returns
        -------
        float
            Height.
        """
        return abs(self.max_corner.y - self.min_corner.y)

📄 README.md

# gdtest-frozen-dc

Tests frozen dataclass documentation.

📄 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: Dataclasses
    desc: Dataclass definitions
    contents:
      - BoundingBox
      - Coordinate  # 1 method(s)

# 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