gdtest_namespace_ug — Synthetic Package Details

#213 gdtest_namespace_ug OK INIT

Namespace package + deeply nested user guide + subdirectory UG. Tests namespace package detection with complex user guide structure.

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

A12 F3 M6

A12Namespace packagelayout

F3Subdirectoriesuser_guide

M6Deeply nested UGuser_guide

Source Files

📁 gdtest_namespace_ug/

📄 __init__.py

"""Namespace package with nested user guide."""

from .core import initialize, shutdown

__version__ = "0.1.0"
__all__ = ["initialize", "shutdown"]

📄 core.py

"""Core lifecycle functions."""


def initialize(config: dict | None = None) -> bool:
    """
    Initialize the application.

    Parameters
    ----------
    config : dict or None
        Optional configuration dictionary.

    Returns
    -------
    bool
        True if initialization succeeded.
    """
    return True


def shutdown(force: bool = False) -> None:
    """
    Shut down the application gracefully.

    Parameters
    ----------
    force : bool
        If True, force immediate shutdown.
    """
    pass

📁 user-guide/

📁 advanced/

📄 configuration.qmd

---
title: Configuration
---

## Configuration Options

Pass a config dict to `initialize()`.

📄 deployment.qmd

---
title: Deployment
---

## Docker Deployment

Use the provided Dockerfile.

## Cloud Deployment

Deploy to your cloud provider.

📄 index.qmd

---
title: Advanced Usage
---

Advanced topics for power users.

📁 getting-started/

📄 index.qmd

---
title: Getting Started
---

Welcome to the getting started guide.

📄 installation.qmd

---
title: Installation
---

## Install

```bash
pip install gdtest-namespace-ug
```

📄 quickstart.qmd

---
title: Quickstart
---

## Quick Start

```python
from gdtest_namespace_ug import initialize
initialize()
```

📄 index.qmd

---
title: User Guide
---

Welcome to the gdtest-namespace-ug user guide.

📄 README.md

# gdtest-namespace-ug

Test package with namespace layout and deeply nested 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: Functions
    desc: Utility functions
    contents:
      - initialize
      - shutdown

# 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