Links

View on PyPI

AI / Agents

Skills
llms.txt
llms-full.txt

gdtest-user-guide-sections

A synthetic test package with sectioned user guide.

Has user_guide/ with four pages that use frontmatter guide-section keys: 01-welcome and 02-install under ‘Getting Started’, 03-customization and 04-plugins under ‘Advanced’. In the sidebar, user guide pages should be grouped under these section headings, not listed flat.

Source files

📁 gdtest_user_guide_sections/

📄 __init__.py

"""A test package with sectioned user guide."""

__version__ = "0.1.0"
__all__ = ["Widget", "create_widget"]


class Widget:
    """
    A UI widget.

    Parameters
    ----------
    label
        Widget label.
    """

    def __init__(self, label: str):
        self.label = label

    def show(self) -> None:
        """Show the widget."""
        pass


def create_widget(label: str) -> Widget:
    """
    Create a new widget.

    Parameters
    ----------
    label
        Widget label.

    Returns
    -------
    Widget
        A new widget.
    """
    return Widget(label)

📁 user_guide/

📄 01-welcome.qmd

---
title: Welcome
guide-section: Getting Started
---

Welcome to the project!

📄 02-install.qmd

---
title: Installation
guide-section: Getting Started
---

How to install the package.

📄 03-customization.qmd

---
title: Customization
guide-section: Advanced
---

Advanced customization options.

📄 04-plugins.qmd

---
title: Plugins
guide-section: Advanced
---

Writing and using plugins.

📄 README.md

# gdtest-user-guide-sections

A synthetic test package with sectioned user guide.

📄 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: Classes
    desc: Main classes provided by the package
    contents:
      - Widget  # 1 method(s)

  - title: Functions
    desc: Utility functions
    contents:
      - create_widget

# 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