gdtest_ug_many_pages — Synthetic Package Details

#156 gdtest_ug_many_pages OK INIT

User guide with 12 numbered pages from overview to appendix.

User guide with 12 pages to test scrolling/navigation with many entries in the sidebar.

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

M8Many UG pagesuser_guide

Source Files

📁 gdtest_ug_many_pages/

📄 __init__.py

"""Test package for many-page user guide."""

📄 core.py

"""Core browse/search functions."""


def browse(page: int) -> str:
    """Browse to a specific page by number.

    Parameters
    ----------
    page : int
        The page number to browse to.

    Returns
    -------
    str
        The content of the requested page.

    Examples
    --------
    >>> browse(1)
    'Page 1 content'
    """
    return f"Page {page} content"


def search(query: str) -> list:
    """Search all pages for the given query string.

    Parameters
    ----------
    query : str
        The search query to match.

    Returns
    -------
    list
        A list of page numbers that match the query.

    Examples
    --------
    >>> search("install")
    [2, 5]
    """
    return []

📁 user_guide/

📄 01-overview.qmd

---
title: Overview
---

# Overview

A high-level overview of the entire project.

📄 02-installation.qmd

---
title: Installation
---

# Installation

Step-by-step installation instructions.

📄 03-quickstart.qmd

---
title: Quickstart
---

# Quickstart

Get up and running in minutes.

📄 04-configuration.qmd

---
title: Configuration
---

# Configuration

All available configuration options.

📄 05-basic-usage.qmd

---
title: Basic Usage
---

# Basic Usage

Common patterns for everyday use.

📄 06-advanced-usage.qmd

---
title: Advanced Usage
---

# Advanced Usage

Power-user techniques and advanced patterns.

📄 07-plugins.qmd

---
title: Plugins
---

# Plugins

How to use and create plugins.

📄 08-testing.qmd

---
title: Testing
---

# Testing

Best practices for testing your project.

📄 09-deployment.qmd

---
title: Deployment
---

# Deployment

Deploying your application to production.

📄 10-troubleshooting.qmd

---
title: Troubleshooting
---

# Troubleshooting

Solutions to common problems and issues.

📄 11-faq.qmd

---
title: FAQ
---

# FAQ

Frequently asked questions and answers.

📄 12-appendix.qmd

---
title: Appendix
---

# Appendix

Supplementary materials and reference tables.

📄 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.