gdtest_seealso — Synthetic Package Details

#028 gdtest_seealso OK INIT

%seealso cross-references between functions

Four exports (Encoder class, encode, decode, validate) with %seealso cross-references. On the Reference page, each function's docs should include a 'See Also' block with links to the related functions. For example, encode's docs should link to decode and validate.

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 C4 D1 E3 F6 G1 H7

A1Flat layoutlayout

B1Explicit __all__exports

C4Mixed class+funcobjects

D1NumPydocstrings

E3%seealsodirectives

F6No user guideuser_guide

G1README.mdlanding

H7No extrasextras

Source Files

📁 gdtest_seealso/

📄 __init__.py

"""Package demonstrating %seealso cross-references."""

__version__ = "0.1.0"
__all__ = ["Encoder", "encode", "decode", "validate"]


class Encoder:
    """
    An encoder/decoder pair.

    %seealso encode, decode

    Parameters
    ----------
    codec
        The codec to use.
    """

    def __init__(self, codec: str = "utf-8"):
        self.codec = codec

    def process(self, data: str) -> bytes:
        """
        Encode the data.

        Parameters
        ----------
        data
            Input string.

        Returns
        -------
        bytes
            Encoded bytes.
        """
        return data.encode(self.codec)


def encode(data: str, codec: str = "utf-8") -> bytes:
    """
    Encode a string to bytes.

    %seealso decode, validate

    Parameters
    ----------
    data
        The string to encode.
    codec
        The codec to use.

    Returns
    -------
    bytes
        The encoded bytes.
    """
    return data.encode(codec)


def decode(data: bytes, codec: str = "utf-8") -> str:
    """
    Decode bytes to a string.

    %seealso encode, validate

    Parameters
    ----------
    data
        The bytes to decode.
    codec
        The codec to use.

    Returns
    -------
    str
        The decoded string.
    """
    return data.decode(codec)


def validate(data: str | bytes) -> bool:
    """
    Validate that data can be encoded/decoded.

    %seealso encode, decode

    Parameters
    ----------
    data
        The data to validate.

    Returns
    -------
    bool
        True if valid.
    """
    return isinstance(data, (str, bytes))

📄 README.md

# gdtest-seealso

A synthetic test package testing ``%seealso`` cross-references.

📄 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:
      - Encoder  # 1 method(s)

  - title: Functions
    desc: Utility functions
    contents:
      - decode
      - encode
      - validate

# 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