Links

View on PyPI

AI / Agents

Skills
llms.txt
llms-full.txt

gdtest-setuptools-find

A synthetic test package using setuptools find packages.

Uses setuptools find:packages with where=src. Module is at src/gdtest_stfind/ (different name from the project). Three exports (Scanner class, scan, report). On the Reference page you should see ‘Classes’ and ‘Functions’ sections. The key test: Great Docs parses setuptools find configuration to locate the correct module.

Source files

📁 src/

📁 gdtest_stfind/

📄 __init__.py

"""A test package using setuptools find packages."""

__version__ = "0.1.0"
__all__ = ["Scanner", "scan", "report"]


class Scanner:
    """
    A file scanner.

    Parameters
    ----------
    root
        Root directory to scan.
    """

    def __init__(self, root: str = "."):
        self.root = root

    def scan(self) -> list:
        """
        Scan the directory.

        Returns
        -------
        list
            List of found files.
        """
        return []


def scan(path: str) -> list:
    """
    Scan a directory for files.

    Parameters
    ----------
    path
        Directory path to scan.

    Returns
    -------
    list
        List of file paths.
    """
    return []


def report(results: list) -> str:
    """
    Generate a report from scan results.

    Parameters
    ----------
    results
        List of scan results.

    Returns
    -------
    str
        Formatted report string.
    """
    return f"Found {len(results)} items"

📄 README.md

# gdtest-setuptools-find

A synthetic test package using setuptools ``find`` packages.

📄 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: gdtest_stfind

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

  - title: Functions
    desc: Utility functions
    contents:
      - report
      - scan

# 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