gdtest_autolink — Synthetic Package Details

#257 gdtest_autolink OK INIT

Autolink inline code to API reference pages. Tests that `Name`, `Name()`, `~~pkg.Name`, and `~~.pkg.Name` in docstring prose are converted to clickable links.

Three classes and a function using inline code (`Name`, `Name()`, `~~pkg.Name`, `~~.pkg.Name`) that gets auto-converted into clickable links to reference pages by the post-render autolink pass.

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_autolink/

📄 __init__.py

"""Package demonstrating autolink of inline code references."""

__version__ = "0.1.0"
__all__ = ["Engine", "Pipeline", "run_pipeline", "Config"]


class Config:
    """Configuration for pipelines.

    Parameters
    ----------
    name
        The config name.
    """

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


class Engine:
    """Core processing engine.

    Use ``Pipeline`` to chain multiple engines together.
    Call ``run_pipeline()`` to execute a full pipeline.

    The ``~~gdtest_autolink.Config`` class holds settings.

    Parameters
    ----------
    name
        The engine name.
    """

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


class Pipeline:
    """A chain of processing steps.

    Each step uses an ``Engine`` instance. Configure with
    ``Config``.

    See ``~~.gdtest_autolink.run_pipeline`` for a shortcut
    to running the full pipeline.

    Parameters
    ----------
    steps
        List of engine names.
    """

    def __init__(self, steps: list = None) -> None:
        self.steps = steps or []


def run_pipeline(data: dict, config: Config = None) -> dict:
    """Execute a full pipeline on the given data.

    Creates a ``Pipeline`` from the ``Config`` and runs each
    ``Engine`` step in order.

    Parameters
    ----------
    data
        Input data to process.
    config
        Pipeline configuration. See ``Config`` for options.

    Returns
    -------
    dict
        Processed output data.
    """
    return data

📄 README.md

# gdtest-autolink

A synthetic test package testing autolink of inline code.

📄 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:
      - Config
      - Engine
      - Pipeline

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

# 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