gdtest-funding

Tests funding config.

Tests funding config with all fields: name, roles, homepage, ror. The funding info should appear somewhere in the rendered site (sidebar or footer). Two functions (donate, sponsor).

Source files

📁 gdtest_funding/

📄 __init__.py

"""Package testing funding config."""

__version__ = "0.1.0"
__all__ = ["donate", "sponsor"]


def donate(amount: float) -> str:
    """
    Record a donation of the given amount.

    Parameters
    ----------
    amount
        The donation amount in dollars.

    Returns
    -------
    str
        A confirmation message.
    """
    return f"Donated ${amount:.2f}"


def sponsor(project: str) -> bool:
    """
    Sponsor a project by name.

    Parameters
    ----------
    project
        The name of the project to sponsor.

    Returns
    -------
    bool
        True if the sponsorship was successful.
    """
    return True

📄 README.md

# gdtest-funding

Tests funding config.

📄 great-docs.yml

funding:
  name: Science Foundation
  roles:
    - Funder
    - Sponsor
  homepage: "https://example.org/grant"
  ror: "https://ror.org/12345"