gdtest_reexports — Synthetic Package Details

#069 gdtest_reexports OK INIT

Submodule re-exports via __init__.py

Package with submodules (core.py, utils.py) that re-exports symbols via __init__.py __all__. On the Reference page you should see the re-exported names (Engine, run, format_result, parse_input) as if they belong to the top-level package. Submodule origins should not be visible.

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 B6 C24 D1 E6 F6 G1 H7

A1Flat layoutlayout

B6Submodule exportsexports

C24Re-exported symbolsobjects

D1NumPydocstrings

E6No directivesdirectives

F6No user guideuser_guide

G1README.mdlanding

H7No extrasextras

Source Files

📁 gdtest_reexports/

📄 __init__.py

"""Package that re-exports from submodules."""

__version__ = "0.1.0"

from gdtest_reexports.core import Engine, run
from gdtest_reexports.utils import format_result, parse_input

__all__ = ["Engine", "run", "format_result", "parse_input"]

📄 core.py

"""Core module with engine logic."""


class Engine:
    """
    Core processing engine.

    Parameters
    ----------
    name
        Engine name.
    """

    def __init__(self, name: str):
        self.name = name

    def execute(self) -> dict:
        """
        Execute the engine.

        Returns
        -------
        dict
            Execution result.
        """
        return {"engine": self.name, "status": "ok"}


def run(engine: Engine) -> dict:
    """
    Run an engine instance.

    Parameters
    ----------
    engine
        Engine to run.

    Returns
    -------
    dict
        Run result.
    """
    return engine.execute()

📄 utils.py

"""Utility functions."""


def format_result(result: dict) -> str:
    """
    Format a result dictionary for display.

    Parameters
    ----------
    result
        Result to format.

    Returns
    -------
    str
        Formatted string.
    """
    return str(result)


def parse_input(text: str) -> dict:
    """
    Parse raw input text into a dictionary.

    Parameters
    ----------
    text
        Raw input text.

    Returns
    -------
    dict
        Parsed data.
    """
    return {"raw": text}

📄 README.md

# gdtest-reexports

Tests re-exports from submodules via __init__.py __all__.

📄 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:
      - Engine  # 1 method(s)

  - title: Functions
    desc: Utility functions
    contents:
      - format_result
      - parse_input
      - run

# 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