gdtest-stress-all-ug

Stress test with maximum user guide complexity.

Maximum user guide complexity: 8 pages, frontmatter sections, subdirs, mixed extensions, numbered, with code blocks. Everything together.

Source files

📁 gdtest_stress_all_ug/

📄 __init__.py

"""Package stress-testing maximum user guide complexity."""

__all__ = ["scaffold", "teardown"]


def scaffold(name: str) -> dict:
    """Scaffold a new project structure.

    Parameters
    ----------
    name : str
        The name of the project to scaffold.

    Returns
    -------
    dict
        A dictionary with the scaffolded project structure.

    Examples
    --------
    >>> scaffold("my-project")
    {'name': 'my-project', 'created': True}
    """
    return {"name": name, "created": True}


def teardown() -> None:
    """Tear down and clean up the current project.

    Returns
    -------
    None

    Examples
    --------
    >>> teardown()
    """
    pass

📁 user_guide/

📁 advanced/

📄 01-architecture.qmd

---
title: Architecture
guide-section: Deep Dive
---

# Architecture

An overview of the system architecture and design decisions.

📄 02-patterns.md

---
title: Patterns
guide-section: Deep Dive
---

# Patterns

Common design patterns used throughout the codebase.

📄 03-optimization.qmd

---
title: Optimization
guide-section: Deep Dive
---

# Optimization

Techniques for optimizing performance and memory usage.

📁 appendix/

📄 01-faq.qmd

---
title: FAQ
guide-section: Appendix
---

# Frequently Asked Questions

Answers to commonly asked questions.

📄 02-glossary.md

---
title: Glossary
guide-section: Appendix
---

# Glossary

Key terms and definitions used in the documentation.

📁 basics/

📄 01-intro.qmd

---
title: Introduction
guide-section: Foundation
---

# Introduction

Welcome to the project. This guide covers the fundamentals.

📄 02-install.md

---
title: Installation
guide-section: Foundation
---

# Installation

Follow these steps to install the package.

```bash
pip install gdtest-stress-all-ug
```

📄 03-quickstart.qmd

---
title: Quickstart
guide-section: Foundation
---

# Quickstart

Get up and running quickly with this guide.

📄 README.md

# gdtest-stress-all-ug

Stress test with maximum user guide complexity.

📄 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:
      - scaffold
      - teardown

# 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