gdtest-auto-discover

A package with no metadata files — tests pure auto-discovery.

No pyproject.toml, no setup.cfg, no setup.py — zero metadata files. Three exports (Engine class, ignite, shutdown). On the Reference page you should see ‘Classes’ and ‘Functions’ sections. The key test: Great Docs discovers the package purely from directory structure.

Source files

📁 gdtest_auto_discover/

📄 __init__.py

"""A test package discovered via auto-discovery."""

__version__ = "0.1.0"


class Engine:
    """
    A simple engine.

    Parameters
    ----------
    power
        Engine power level.
    """

    def __init__(self, power: int = 100):
        self.power = power

    def start(self) -> bool:
        """
        Start the engine.

        Returns
        -------
        bool
            True if started.
        """
        return True

    def stop(self) -> None:
        """Stop the engine."""
        pass


def ignite(engine: "Engine") -> bool:
    """
    Ignite an engine.

    Parameters
    ----------
    engine
        The engine to ignite.

    Returns
    -------
    bool
        True if ignited.
    """
    return engine.start()


def shutdown(engine: "Engine") -> None:
    """
    Shut down an engine.

    Parameters
    ----------
    engine
        The engine to shut down.
    """
    engine.stop()

📄 README.md

# gdtest-auto-discover

A package with no metadata files — tests pure auto-discovery.

📄 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  # 2 method(s)

  - title: Functions
    desc: Utility functions
    contents:
      - ignite
      - shutdown

# 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