gdtest_unicode_docs — Synthetic Package Details

#087 gdtest_unicode_docs OK INIT

Docstrings with unicode characters

Docstrings with unicode characters: accented names (René), emoji (📊), CJK characters (数据), mathematical symbols (∫∑∏). On the Reference page all characters should render correctly without encoding errors. Key test: unicode safety.

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 F6 G1 H7

A1Flat layoutlayout

B1Explicit __all__exports

C1Functions onlyobjects

D1NumPydocstrings

E6No directivesdirectives

F6No user guideuser_guide

G1README.mdlanding

H7No extrasextras

Source Files

📁 gdtest_unicode_docs/

📄 __init__.py

"""Package with unicode-heavy docstrings."""

__version__ = "0.1.0"
__all__ = ["greet_international", "analyze_text", "compute_stats"]


def greet_international(name: str, language: str = "en") -> str:
    """
    Greet someone in their language.

    Supported greetings include:

    - English: "Hello"
    - French: "Bonjour" (by Ren\u00e9 Descartes)
    - Japanese: "\u3053\u3093\u306b\u3061\u306f"
    - Chinese: "\u4f60\u597d"
    - Arabic: "\u0645\u0631\u062d\u0628\u0627"
    - Emoji: "\U0001f44b"

    Parameters
    ----------
    name
        The person's name.
    language
        Language code (en, fr, ja, zh, ar).

    Returns
    -------
    str
        Greeting string.
    """
    greetings = {
        "en": "Hello",
        "fr": "Bonjour",
        "ja": "\u3053\u3093\u306b\u3061\u306f",
        "zh": "\u4f60\u597d",
        "ar": "\u0645\u0631\u062d\u0628\u0627",
    }
    return f"{greetings.get(language, 'Hello')}, {name}! \U0001f44b"


def analyze_text(text: str) -> dict:
    """
    Analyze text with support for unicode characters.

    Handles various scripts: Latin (caf\u00e9), Greek (\u03b1\u03b2\u03b3),
    Cyrillic (\u041f\u0440\u0438\u0432\u0435\u0442), CJK (\u6570\u636e\u5206\u6790).

    Statistical symbols: \u03bc (mean), \u03c3 (std dev), \u03a3 (sum).

    Parameters
    ----------
    text
        Input text (any unicode).

    Returns
    -------
    dict
        Analysis with keys: length, unique_chars, scripts.
    """
    return {
        "length": len(text),
        "unique_chars": len(set(text)),
    }


def compute_stats(values: list) -> dict:
    """
    Compute basic statistics.

    Returns \u03bc (mean) and \u03c3 (standard deviation).

    Mathematical notation: \u03bc = \u03a3x\u1d62/n

    Set operations: A \u222a B, A \u2229 B, A \u2286 B

    Integral: \u222b f(x)dx, Product: \u220f x\u1d62

    Parameters
    ----------
    values
        Numeric values.

    Returns
    -------
    dict
        Statistics dictionary with \u03bc and \u03c3.
    """
    n = len(values)
    if n == 0:
        return {"\u03bc": 0, "\u03c3": 0}
    mean = sum(values) / n
    variance = sum((x - mean) ** 2 for x in values) / n
    return {"\u03bc": mean, "\u03c3": variance ** 0.5}

📄 README.md

# gdtest-unicode-docs

Tests unicode characters in docstrings: café, 📊, 数据, ∫Σ∏.

📄 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:
      - analyze_text
      - compute_stats
      - greet_international

# 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