gdtest_protocols — Synthetic Package Details

#023 gdtest_protocols OK INIT

ABC + Protocol abstract types

Serializable (ABC) and Renderable (Protocol) with abstract methods. On the Reference page you should see a 'Classes' section listing both. Abstract methods should be shown with their signatures. The key test: ABC/Protocol types are handled 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 C8 D1 E6 F6 G1 H7

A1Flat layoutlayout

B1Explicit __all__exports

C8ABC/Protocolobjects

D1NumPydocstrings

E6No directivesdirectives

F6No user guideuser_guide

G1README.mdlanding

H7No extrasextras

Source Files

📁 gdtest_protocols/

📄 __init__.py

"""A test package with abstract base classes and protocols."""

__version__ = "0.1.0"
__all__ = ["Serializable", "Renderable"]

from abc import ABC, abstractmethod
from typing import Protocol, runtime_checkable


class Serializable(ABC):
    """
    Abstract base class for serializable objects.

    Subclasses must implement ``to_bytes`` and ``from_bytes``.
    """

    @abstractmethod
    def to_bytes(self) -> bytes:
        """
        Serialize this object to bytes.

        Returns
        -------
        bytes
            The serialized representation.
        """
        ...

    @abstractmethod
    def from_bytes(self, data: bytes) -> "Serializable":
        """
        Deserialize from bytes.

        Parameters
        ----------
        data
            The bytes to deserialize.

        Returns
        -------
        Serializable
            A new instance.
        """
        ...

    def size(self) -> int:
        """
        Get the serialized size.

        Returns
        -------
        int
            Size in bytes.
        """
        return len(self.to_bytes())


@runtime_checkable
class Renderable(Protocol):
    """
    Protocol for objects that can be rendered to string.

    Any object with a ``render`` method returning ``str``
    satisfies this protocol.
    """

    def render(self) -> str:
        """
        Render this object as a string.

        Returns
        -------
        str
            The rendered representation.
        """
        ...

📄 README.md

# gdtest-protocols

A synthetic test package with ``ABC`` and ``Protocol``.

📄 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: Abstract Classes
    desc: Abstract base classes
    contents:
      - Serializable  # 3 method(s)

  - title: Protocols
    desc: Protocol / structural-typing interfaces
    contents:
      - Renderable  # 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