#279
gdtest_interlinks_userguide
OK
INIT
Interlinks syntax in user-guide pages. Tests that [](`~Name`) references and inline-code autolinking work on non-reference pages via the all-pages GDLS pass.
Three exports (Engine, Connection, execute) with user-guide pages using [](`~pkg.Name`) interlinks and inline-code autolinking. Tests that the GDLS resolves links on non-reference pages with correct relative paths back to reference/.
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 F1 L26
A1Flat layoutlayout
D1NumPydocstrings
F1Auto-discoveruser_guide
L26Interlinks in prosedocstring
Source Files
gdtest_interlinks_userguide/
__init__.py
"""Package demonstrating interlinks in user-guide pages."""
__version__ = "0.1.0"
__all__ = ["Engine", "Connection", "execute"]
class Engine:
"""Database engine that manages connections.
Use [](`~gdtest_interlinks_userguide.Connection`) to interact
with the database.
Parameters
----------
url
Database connection URL.
"""
def __init__(self, url: str) -> None:
self.url = url
class Connection:
"""Active database connection.
Created by [](`~gdtest_interlinks_userguide.Engine`).
Parameters
----------
engine
The engine that spawned this connection.
"""
def __init__(self, engine: Engine) -> None:
self.engine = engine
def execute(conn: Connection, query: str) -> list:
"""Execute a SQL query on a connection.
Parameters
----------
conn
An active [](`~gdtest_interlinks_userguide.Connection`).
query
The SQL query string.
Returns
-------
list
Query results.
"""
return []user_guide/
01-getting-started.qmd
---
title: Getting Started
---
## Creating an Engine
To connect to a database, first create an
[](`~gdtest_interlinks_userguide.Engine`) instance:
```python
from gdtest_interlinks_userguide import Engine
engine = Engine("sqlite:///mydb.db")
```
## Opening a Connection
Use the engine to open a
[](`~gdtest_interlinks_userguide.Connection`):
```python
conn = Connection(engine)
```
## Running Queries
Call [](`~gdtest_interlinks_userguide.execute`) to run SQL:
```python
results = execute(conn, "SELECT * FROM users")
```
See the [API Reference](../reference/index.qmd) for full details.02-advanced.qmd
--- title: Advanced Usage --- ## Full Qualified References You can reference the full path: [](`gdtest_interlinks_userguide.Engine`). ## Custom Link Text Or use [custom link text](`gdtest_interlinks_userguide.Connection`) for any reference. ## Custom Text with Tilde And also [custom text with tilde](`~gdtest_interlinks_userguide.execute`) to override display. ## Autolinked Code Inline code like `Engine` and `Connection` and `execute()` should be automatically linked to reference pages.
README.md
# gdtest-interlinks-userguide A synthetic test package testing interlinks in user-guide pages.
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:
- Connection
- Engine
- title: Functions
desc: Utility functions
contents:
- execute
# 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