gdtest_sphinx — Synthetic Package Details

#003 gdtest_sphinx OK INIT

Sphinx/reST-style docstrings; format_duration is %nodoc and should not appear

Three exports (Timer class, start_timer, format_duration) with classic Sphinx :param:/:returns:/:rtype:/:raises: field lists. On the Reference page you should see 'Classes' and 'Functions' sections. Parameter types and defaults should be rendered from the Sphinx field list syntax, not shown as raw :param: markers.

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 C4 D3 E6 F6 G1 H7

A1Flat layoutlayout

B1Explicit __all__exports

C4Mixed class+funcobjects

D3Sphinxdocstrings

E6No directivesdirectives

F6No user guideuser_guide

G1README.mdlanding

H7No extrasextras

Source Files

📁 gdtest_sphinx/

📄 __init__.py

"""A test package using Sphinx/reST-style docstrings."""

__version__ = "0.1.0"
__all__ = ["Timer", "start_timer", "format_duration"]


class Timer:
    """A simple timer for measuring elapsed time.

    :param label: A label for this timer instance.
    :type label: str
    :param auto_start: Whether to start timing immediately.
    :type auto_start: bool
    """

    def __init__(self, label: str, auto_start: bool = False):
        self.label = label
        self._elapsed = 0.0
        if auto_start:
            self.start()

    def start(self) -> None:
        """Start the timer.

        :raises RuntimeError: If the timer is already running.
        """
        pass

    def stop(self) -> float:
        """Stop the timer and return elapsed time.

        :returns: The elapsed time in seconds.
        :rtype: float
        """
        return self._elapsed

    def reset(self) -> None:
        """Reset the timer to zero."""
        self._elapsed = 0.0


def start_timer(label: str) -> Timer:
    """Create and start a new timer.

    :param label: The timer label.
    :type label: str
    :returns: A started timer instance.
    :rtype: Timer
    """
    return Timer(label, auto_start=True)


def format_duration(seconds: float, precision: int = 2) -> str:
    """Format a duration in seconds as a human-readable string.

    %nodoc

    :param seconds: The duration in seconds.
    :param precision: Number of decimal places.
    :returns: Formatted duration string (e.g., ``"1.50s"``).
    :rtype: str
    """
    return f"{seconds:.{precision}f}s"

📄 README.md

# gdtest-sphinx

A synthetic test package with Sphinx/reST-style 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: sphinx

# 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:
      - Timer  # 3 method(s)

  - title: Functions
    desc: Utility functions
    contents:
      - format_duration
      - start_timer

# 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