← GDG /

#097 gdtest_source_disabled

#097 gdtest_source_disabled OK CONFIG
Tests source.enabled: false config
Tests source.enabled: false. No source code links should appear anywhere in the rendered docs. Two functions (encrypt, decrypt) with NumPy docstrings.
View Site → Build Log ๐Ÿงช Test Coverage

Build Mode

● Has great-docs.yml

This package ships a pre-supplied config. The great-docs init step is skipped and great-docs build uses the spec-defined configuration directly. Tests specific config options and their rendered output.

Dimensions

K5
K5source.enabled: falseconfig

Source Files

๐Ÿ“ gdtest_source_disabled/
๐Ÿ“„ __init__.py
"""Package testing source.enabled false config."""

__version__ = "0.1.0"
__all__ = ["encrypt", "decrypt"]


def encrypt(text: str, key: str) -> str:
    """
    Encrypt text with a key.

    Parameters
    ----------
    text
        The plaintext to encrypt.
    key
        The encryption key.

    Returns
    -------
    str
        The encrypted text.
    """
    return ""


def decrypt(text: str, key: str) -> str:
    """
    Decrypt text with a key.

    Parameters
    ----------
    text
        The ciphertext to decrypt.
    key
        The decryption key.

    Returns
    -------
    str
        The decrypted text.
    """
    return ""
๐Ÿ“„ README.md
# gdtest-source-disabled

Tests source.enabled: false config.
๐Ÿ“„ great-docs.yml
source:
  enabled: false