gdtest_slots_class — Synthetic Package Details

#063 gdtest_slots_class OK INIT

Class using __slots__

Class using __slots__ = ('x', 'y', 'label') instead of __dict__. SlottedPoint class with three slots and four methods. On the Reference page you should see the class with its methods.

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

A1Flat layoutlayout

B1Explicit __all__exports

C18__slots__ classesobjects

D1NumPydocstrings

E6No directivesdirectives

F6No user guideuser_guide

G1README.mdlanding

H7No extrasextras

Source Files

📁 gdtest_slots_class/

📄 __init__.py

"""Package with a __slots__ class."""

__version__ = "0.1.0"
__all__ = ["SlottedPoint"]


class SlottedPoint:
    """
    A 2D point using __slots__ for memory efficiency.

    Parameters
    ----------
    x
        X coordinate.
    y
        Y coordinate.
    label
        Optional label for the point.
    """

    __slots__ = ("x", "y", "label")

    def __init__(self, x: float, y: float, label: str = ""):
        self.x = x
        self.y = y
        self.label = label

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

        Parameters
        ----------
        other
            The other point.

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

    def translate(self, dx: float, dy: float) -> "SlottedPoint":
        """
        Return a new point translated by (dx, dy).

        Parameters
        ----------
        dx
            X offset.
        dy
            Y offset.

        Returns
        -------
        SlottedPoint
            New translated point.
        """
        return SlottedPoint(self.x + dx, self.y + dy, self.label)

    def as_tuple(self) -> tuple:
        """
        Return coordinates as tuple.

        Returns
        -------
        tuple
            (x, y) tuple.
        """
        return (self.x, self.y)

    def __repr__(self) -> str:
        """Return string representation."""
        return f"SlottedPoint({self.x}, {self.y}, {self.label!r})"

📄 README.md

# gdtest-slots-class

Tests documentation of a class using __slots__.

📄 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: Classes
    desc: Main classes provided by the package
    contents:
      - SlottedPoint  # 4 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