gdtest-ug-combo

Complex user guide combining numbered files, sections, subdirs, and mixed extensions.

Combination: numbered files + frontmatter sections + subdirs + mixed extensions. Complex user guide structure.

Source files

📁 gdtest_ug_combo/

📄 __init__.py

"""Test package for complex user guide combo."""

📄 core.py

"""Core build/deploy functions."""


def build(config: dict) -> None:
    """Build the project with the given configuration.

    Parameters
    ----------
    config : dict
        A dictionary of build configuration options.

    Returns
    -------
    None

    Examples
    --------
    >>> build({"target": "production"})
    """
    pass


def deploy(target: str) -> str:
    """Deploy the project to the specified target.

    Parameters
    ----------
    target : str
        The deployment target name.

    Returns
    -------
    str
        A status message indicating the result of the deployment.

    Examples
    --------
    >>> deploy("staging")
    'Deployed to staging'
    """
    return f"Deployed to {target}"

📁 user_guide/

📁 advanced/

📄 01-config.qmd

---
title: Configuration
guide-section: Advanced
---

# Configuration

Advanced configuration options for the project.

📄 02-extend.qmd

---
title: Extending
guide-section: Advanced
---

# Extending

How to extend the project with custom plugins.

📁 basics/

📄 01-intro.qmd

---
title: Introduction
guide-section: Basics
---

# Introduction

An introduction to the basics of the project.

📄 02-install.md

---
title: Installation
guide-section: Basics
---

# Installation

How to install the project using pip.

📄 README.md

# gdtest-ug-combo

Complex user guide combining numbered files, sections, subdirs, and mixed extensions.

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