gdtest_math_docs — Synthetic Package Details

#085 gdtest_math_docs OK INIT

Docstrings with LaTeX math notation

Docstrings containing LaTeX math notation: inline $x^2$ and block $$\\sum_{i=1}^n x_i$$ equations. On the Reference page the math should render as formatted equations (or at minimum not break the page). Key test: math in docstrings.

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_math_docs/

📄 __init__.py

"""Package with math-heavy docstrings."""

import math

__version__ = "0.1.0"
__all__ = ["euclidean_distance", "sigmoid", "softmax"]


def euclidean_distance(x: list, y: list) -> float:
    """
    Compute Euclidean distance between two vectors.

    The Euclidean distance is defined as:

    .. math::

        d(x, y) = \\sqrt{\\sum_{i=1}^{n} (x_i - y_i)^2}

    Parameters
    ----------
    x
        First vector.
    y
        Second vector.

    Returns
    -------
    float
        The Euclidean distance :math:`d(x, y)`.
    """
    return math.sqrt(sum((a - b) ** 2 for a, b in zip(x, y)))


def sigmoid(x: float) -> float:
    """
    Compute the sigmoid function.

    The sigmoid function is :math:`\\sigma(x) = \\frac{1}{1 + e^{-x}}`.

    Parameters
    ----------
    x
        Input value.

    Returns
    -------
    float
        Sigmoid output in range :math:`(0, 1)`.
    """
    return 1.0 / (1.0 + math.exp(-x))


def softmax(values: list) -> list:
    """
    Compute softmax probabilities.

    For a vector :math:`z`, the softmax of element :math:`j` is:

    .. math::

        \\text{softmax}(z)_j = \\frac{e^{z_j}}{\\sum_{k=1}^{K} e^{z_k}}

    Parameters
    ----------
    values
        Input values.

    Returns
    -------
    list
        Probability distribution that sums to 1.
    """
    max_val = max(values)
    exps = [math.exp(v - max_val) for v in values]
    total = sum(exps)
    return [e / total for e in exps]

📄 README.md

# gdtest-math-docs

Tests LaTeX math notation in docstrings.

📄 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:
      - euclidean_distance
      - sigmoid
      - softmax

# 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