#049
gdtest_google_big_class
OK
INIT
Google docstrings with a big class (>5 methods)
Google docstrings (D2) with a big class (C3). DataProcessor has 7 methods all documented in Google style. On the Reference page you should see the class with a separate methods subsection, and each method's Args/Returns sections should be parsed correctly from Google format — not shown as raw text.
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 C3 D2 E6 F6 G1 H7
A1Flat layoutlayout
B1Explicit __all__exports
C3Big class (>5)objects
D2Googledocstrings
E6No directivesdirectives
F6No user guideuser_guide
G1README.mdlanding
H7No extrasextras
Source Files
gdtest_google_big_class/
__init__.py
"""Package with a big class using Google-style docstrings."""
__version__ = "0.1.0"
__all__ = ["DataProcessor", "load_data"]
class DataProcessor:
"""A processor for tabular data.
Args:
source: Data source path.
format: Data format string.
"""
def __init__(self, source: str, format: str = "csv"):
self.source = source
self.format = format
def load(self) -> list:
"""Load data from the source.
Returns:
A list of records.
"""
return []
def filter(self, predicate) -> "DataProcessor":
"""Filter data using a predicate function.
Args:
predicate: A callable that returns True for items to keep.
Returns:
A new DataProcessor with filtered data.
"""
return self
def sort(self, key: str, reverse: bool = False) -> "DataProcessor":
"""Sort data by a key.
Args:
key: Column name to sort by.
reverse: If True, sort in descending order.
Returns:
A new DataProcessor with sorted data.
"""
return self
def aggregate(self, column: str, func: str = "sum") -> dict:
"""Aggregate values in a column.
Args:
column: Column to aggregate.
func: Aggregation function name.
Returns:
Dictionary with aggregation results.
"""
return {}
def export(self, path: str, format: str = "csv") -> None:
"""Export data to a file.
Args:
path: Output file path.
format: Output format.
"""
pass
def describe(self) -> dict:
"""Generate summary statistics.
Returns:
Dictionary of column statistics.
"""
return {}
def head(self, n: int = 5) -> list:
"""Return the first n records.
Args:
n: Number of records to return.
Returns:
List of the first n records.
"""
return []
def load_data(path: str) -> DataProcessor:
"""Load data from a file into a DataProcessor.
Args:
path: Path to the data file.
Returns:
A DataProcessor instance with the loaded data.
"""
return DataProcessor(path)README.md
# gdtest-google-big-class Tests Google docstring parsing with big class method extraction.
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: google
# 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:
- name: DataProcessor
members: false # 7 methods listed below
- title: DataProcessor Methods
desc: Methods for the DataProcessor class
contents:
- DataProcessor.load
- DataProcessor.filter
- DataProcessor.sort
- DataProcessor.aggregate
- DataProcessor.export
- DataProcessor.describe
- DataProcessor.head
- title: Functions
desc: Utility functions
contents:
- load_data
# 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