gdtest_src_big_class — Synthetic Package Details

#048 gdtest_src_big_class OK INIT

src/ layout with a big class (>5 methods)

src/ layout (A2) with a big class (C3) having 7 methods. Module at src/gdtest_src_big_class/. Pipeline class with add_step, remove_step, run, pause, resume, reset, status. On the Reference page you should see 'Classes' and a separate 'Pipeline Methods' subsection. Key test: big-class method extraction works from src/ layout.

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

A2 B1 C3 D1 E6 F6 G1 H7

A2src/ layoutlayout

B1Explicit __all__exports

C3Big class (>5)objects

D1NumPydocstrings

E6No directivesdirectives

F6No user guideuser_guide

G1README.mdlanding

H7No extrasextras

Source Files

📁 src/

📁 gdtest_src_big_class/

📄 __init__.py

"""Package with a big class inside src/ layout."""

__version__ = "0.1.0"
__all__ = ["Pipeline", "create_pipeline"]


class Pipeline:
    """
    A data processing pipeline with many stages.

    Parameters
    ----------
    name
        Pipeline name.
    """

    def __init__(self, name: str):
        self.name = name
        self._steps = []

    def add_step(self, step: str) -> "Pipeline":
        """
        Add a processing step.

        Parameters
        ----------
        step
            Step name to add.

        Returns
        -------
        Pipeline
            Self for chaining.
        """
        self._steps.append(step)
        return self

    def remove_step(self, index: int) -> None:
        """
        Remove a step by index.

        Parameters
        ----------
        index
            Index of step to remove.
        """
        self._steps.pop(index)

    def run(self) -> dict:
        """
        Execute the pipeline.

        Returns
        -------
        dict
            Execution results.
        """
        return {"status": "ok"}

    def pause(self) -> None:
        """Pause pipeline execution."""
        pass

    def resume(self) -> None:
        """Resume pipeline execution."""
        pass

    def reset(self) -> None:
        """Reset pipeline to initial state."""
        self._steps.clear()

    def status(self) -> str:
        """
        Get pipeline status.

        Returns
        -------
        str
            Current status string.
        """
        return "idle"


def create_pipeline(name: str) -> Pipeline:
    """
    Create a new pipeline.

    Parameters
    ----------
    name
        Name for the pipeline.

    Returns
    -------
    Pipeline
        A new Pipeline instance.
    """
    return Pipeline(name)

📄 README.md

# gdtest-src-big-class

Tests big class method extraction within a src/ layout.

📄 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: Classes
    desc: Main classes provided by the package
    contents:
      - name: Pipeline
        members: false  # 7 methods listed below

  - title: Pipeline Methods
    desc: Methods for the Pipeline class
    contents:
      - Pipeline.add_step
      - Pipeline.remove_step
      - Pipeline.run
      - Pipeline.pause
      - Pipeline.resume
      - Pipeline.reset
      - Pipeline.status

  - title: Functions
    desc: Utility functions
    contents:
      - create_pipeline

# 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