gdtest_ug_with_images — Synthetic Package Details

#161 gdtest_ug_with_images OK INIT

User guide with pages referencing assets like diagrams.

User guide page referencing images from an assets directory. Images should be copied and displayed correctly.

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

M1Auto-discover UGuser_guide

Source Files

📁 assets/

📄 architecture.svg

<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 400 120">
  <rect x="10" y="40" width="100" height="40" rx="6" fill="#4A90D9" stroke="#2C5F8A" stroke-width="2"/>
  <text x="60" y="65" text-anchor="middle" fill="white" font-size="14">Component A</text>
  <line x1="110" y1="60" x2="150" y2="60" stroke="#333" stroke-width="2" marker-end="url(#arrow)"/>
  <rect x="150" y="40" width="100" height="40" rx="6" fill="#7B68EE" stroke="#5A4CBE" stroke-width="2"/>
  <text x="200" y="65" text-anchor="middle" fill="white" font-size="14">Component B</text>
  <line x1="250" y1="60" x2="290" y2="60" stroke="#333" stroke-width="2" marker-end="url(#arrow)"/>
  <rect x="290" y="40" width="100" height="40" rx="6" fill="#3CB371" stroke="#2D8659" stroke-width="2"/>
  <text x="340" y="65" text-anchor="middle" fill="white" font-size="14">Component C</text>
  <defs><marker id="arrow" viewBox="0 0 10 10" refX="10" refY="5" markerWidth="6" markerHeight="6" orient="auto">
    <path d="M 0 0 L 10 5 L 0 10 z" fill="#333"/>
  </marker></defs>
</svg>

📄 data-flow.svg

<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 400 160">
  <rect x="150" y="5" width="100" height="30" rx="4" fill="#F0AD4E" stroke="#C68E2C" stroke-width="2"/>
  <text x="200" y="25" text-anchor="middle" fill="white" font-size="12">Ingestion</text>
  <line x1="200" y1="35" x2="200" y2="55" stroke="#333" stroke-width="2" marker-end="url(#arr)"/>
  <rect x="150" y="55" width="100" height="30" rx="4" fill="#5BC0DE" stroke="#3AA8C7" stroke-width="2"/>
  <text x="200" y="75" text-anchor="middle" fill="white" font-size="12">Processing</text>
  <line x1="200" y1="85" x2="200" y2="105" stroke="#333" stroke-width="2" marker-end="url(#arr)"/>
  <rect x="150" y="105" width="100" height="30" rx="4" fill="#D9534F" stroke="#B94441" stroke-width="2"/>
  <text x="200" y="125" text-anchor="middle" fill="white" font-size="12">Storage</text>
  <defs><marker id="arr" viewBox="0 0 10 10" refX="10" refY="5" markerWidth="6" markerHeight="6" orient="auto">
    <path d="M 0 0 L 10 5 L 0 10 z" fill="#333"/>
  </marker></defs>
</svg>

📁 gdtest_ug_with_images/

📄 __init__.py

"""Test package for user guide with image references."""

📄 core.py

"""Core render/display functions."""


def render(template: str) -> str:
    """Render a template string.

    Parameters
    ----------
    template : str
        The template string to render.

    Returns
    -------
    str
        The rendered output.

    Examples
    --------
    >>> render("Hello, {{ name }}")
    'Hello, World'
    """
    return template


def display(content: str) -> None:
    """Display content to the user.

    Parameters
    ----------
    content : str
        The content to display.

    Returns
    -------
    None

    Examples
    --------
    >>> display("Hello")
    """
    pass

📁 user_guide/

📄 visual-guide.qmd

---
title: Visual Guide
---

# Visual Guide

Below is the architecture diagram showing how the main components connect:

![Architecture Diagram](../assets/architecture.svg)

The diagram above shows the main components of the system.

## Data Flow

The following diagram illustrates the data flow between components:

![Data Flow Diagram](../assets/data-flow.svg)

Data moves from ingestion through processing to storage.

📄 README.md

# gdtest-ug-with-images

Test user guide with asset 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

# Exclusions
# ----------
# Items to exclude from auto-documentation (affects 'init' and 'scan')
# 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

# 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

# API Reference Structure
# -----------------------
# Auto-discovery couldn't determine your package's public API.
# You can manually specify which items to document here.
#
# Uncomment and customize the reference section below:
#
# reference:
#   - title: Functions
#     desc: Public functions provided by the package
#     contents:
#       - my_function
#       - another_function
#
#   - title: Classes
#     desc: Main classes for working with the package
#     contents:
#       - name: MyClass
#         members: false       # Don't document methods inline
#       - SimpleClass          # Methods documented inline (default)
#
# After editing, run 'great-docs build' to generate your documentation.