Links

View on PyPI

AI / Agents

Skills
llms.txt
llms-full.txt

gdtest-multi-module

Tests multi-module package with re-exports.

Package with three submodules (models.py, views.py, controllers.py) re-exported via init.py. On the Reference page you should see all exports merged: Model, View, Controller classes plus create, render, dispatch functions. Key test: multi-module packages.

Source files

📁 gdtest_multi_module/

📄 __init__.py

"""Package with multiple submodules."""

__version__ = "0.1.0"

from gdtest_multi_module.models import Model, create_model
from gdtest_multi_module.views import View, render_view
from gdtest_multi_module.controllers import Controller, dispatch

__all__ = [
    "Model", "create_model",
    "View", "render_view",
    "Controller", "dispatch",
]

📄 controllers.py

"""Controller definitions."""


class Controller:
    """
    A request controller.

    Parameters
    ----------
    name
        Controller name.
    """

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

    def handle(self, request: dict) -> dict:
        """
        Handle a request.

        Parameters
        ----------
        request
            Request data.

        Returns
        -------
        dict
            Response data.
        """
        return {"status": "ok"}


def dispatch(path: str) -> Controller:
    """
    Dispatch a request to the appropriate controller.

    Parameters
    ----------
    path
        Request path.

    Returns
    -------
    Controller
        Matched controller.
    """
    return Controller(path)

📄 models.py

"""Model definitions."""


class Model:
    """
    A data model.

    Parameters
    ----------
    name
        Model name.
    """

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

    def save(self) -> bool:
        """
        Save the model.

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


def create_model(name: str) -> Model:
    """
    Create a new model.

    Parameters
    ----------
    name
        Model name.

    Returns
    -------
    Model
        New model instance.
    """
    return Model(name)

📄 views.py

"""View definitions."""


class View:
    """
    A display view.

    Parameters
    ----------
    template
        View template name.
    """

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

    def render(self) -> str:
        """
        Render the view.

        Returns
        -------
        str
            Rendered HTML.
        """
        return f"<div>{self.template}</div>"


def render_view(view: View) -> str:
    """
    Render a view and return its content.

    Parameters
    ----------
    view
        View to render.

    Returns
    -------
    str
        Rendered content.
    """
    return view.render()

📄 README.md

# gdtest-multi-module

Tests multi-module package with re-exports.

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

  - title: Functions
    desc: Utility functions
    contents:
      - create_model
      - dispatch
      - render_view

# 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