gdtest_many_guides — Synthetic Package Details

#073 gdtest_many_guides OK INIT

User guide with 10 pages

User guide with 10 pages (01-introduction through 10-appendix). The sidebar should list all 10 pages in order. Scrolling the sidebar should show every page. Key test: large user guide count doesn't break sidebar rendering.

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 B1 C1 D1 E6 F1 G1 H7

A1Flat layoutlayout

B1Explicit __all__exports

C1Functions onlyobjects

D1NumPydocstrings

E6No directivesdirectives

F1Auto-discoveruser_guide

G1README.mdlanding

H7No extrasextras

Source Files

📁 gdtest_many_guides/

📄 __init__.py

"""Package with many user guide pages."""

__version__ = "0.1.0"
__all__ = ["run_app"]


def run_app() -> None:
    """
    Run the application.

    Returns
    -------
    None
    """
    pass

📁 user_guide/

📄 01-introduction.qmd

---
title: "Introduction"
---

## Introduction

Content for the introduction guide page.

📄 02-installation.qmd

---
title: "Installation"
---

## Installation

Content for the installation guide page.

📄 03-quickstart.qmd

---
title: "Quick Start"
---

## Quick Start

Content for the quick start guide page.

📄 04-configuration.qmd

---
title: "Configuration"
---

## Configuration

Content for the configuration guide page.

📄 05-basic-usage.qmd

---
title: "Basic Usage"
---

## Basic Usage

Content for the basic usage guide page.

📄 06-advanced-usage.qmd

---
title: "Advanced Usage"
---

## Advanced Usage

Content for the advanced usage guide page.

📄 07-plugins.qmd

---
title: "Plugins"
---

## Plugins

Content for the plugins guide page.

📄 08-deployment.qmd

---
title: "Deployment"
---

## Deployment

Content for the deployment guide page.

📄 09-troubleshooting.qmd

---
title: "Troubleshooting"
---

## Troubleshooting

Content for the troubleshooting guide page.

📄 10-appendix.qmd

---
title: "Appendix"
---

## Appendix

Content for the appendix guide page.

📄 README.md

# gdtest-many-guides

Tests user guide with 10 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: Functions
    desc: Utility functions
    contents:
      - run_app

# 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