gdtest_interlinks_prose — Synthetic Package Details

#256 gdtest_interlinks_prose OK INIT

Interlinks syntax in docstring prose. Tests that [](`~Name`) references inside description text are resolved to proper hyperlinks by the post-render step.

Three classes and a function using [](`~pkg.Name`) interlinks syntax directly in docstring prose text. Tests that the post-render resolver converts these references into proper hyperlinks to reference pages.

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 D1 E3 L26

A1Flat layoutlayout

D1NumPydocstrings

E3%seealsodirectives

L26Interlinks in prosedocstring

Source Files

📁 gdtest_interlinks_prose/

📄 __init__.py

"""Package demonstrating interlinks in docstring prose."""

__version__ = "0.1.0"
__all__ = ["BaseStore", "DuckDBStore", "ChromaDBStore", "query"]


class BaseStore:
    """Base class for all stores.

    Available implementations:

    - [](`~gdtest_interlinks_prose.DuckDBStore`): local storage with
      embedded search.
    - [](`~gdtest_interlinks_prose.ChromaDBStore`): vector storage
      using ChromaDB.

    Parameters
    ----------
    name
        The name of the store.
    """

    def __init__(self, name: str) -> None:
        self.name = name


class DuckDBStore(BaseStore):
    """Local storage backed by DuckDB.

    Inherits from [](`~gdtest_interlinks_prose.BaseStore`).
    Use [](`~gdtest_interlinks_prose.query`) to search the store
    after loading data.

    Parameters
    ----------
    name
        The name of the store.
    path
        Path to the DuckDB database file.
    """

    def __init__(self, name: str, path: str = ":memory:") -> None:
        super().__init__(name)
        self.path = path


class ChromaDBStore(BaseStore):
    """Vector storage using ChromaDB.

    Inherits from [](`gdtest_interlinks_prose.BaseStore`).
    See [the DuckDB-backed store](`~gdtest_interlinks_prose.DuckDBStore`) for a
    simpler alternative.

    Parameters
    ----------
    name
        The name of the store.
    collection
        The ChromaDB collection name.
    """

    def __init__(self, name: str, collection: str = "default") -> None:
        super().__init__(name)
        self.collection = collection


def query(store: BaseStore, text: str) -> list:
    """Search a store for matching documents.

    Works with any [](`~gdtest_interlinks_prose.BaseStore`)
    implementation, including
    [](`gdtest_interlinks_prose.DuckDBStore`) and
    [the ChromaDB store](`gdtest_interlinks_prose.ChromaDBStore`).

    Parameters
    ----------
    store
        The store to search. Must be an instance of
        [a base store](`~gdtest_interlinks_prose.BaseStore`).
    text
        The search query string.

    Returns
    -------
    list
        Matching documents.
    """
    return []

📄 README.md

# gdtest-interlinks-prose

A synthetic test package testing interlinks in docstring prose.

📄 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:
      - BaseStore
      - ChromaDBStore
      - DuckDBStore

  - title: Functions
    desc: Utility functions
    contents:
      - query

# 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