gdtest_rst_important — Synthetic Package Details

#132 gdtest_rst_important OK CONFIG

Tests important RST directives in docstrings

Docstrings contain '.. important::' directives. The built-in handler should produce Quarto important callouts. Two functions exercise them.

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

L8.. important::docstring

Source Files

📁 gdtest_rst_important/

📄 __init__.py

"""Package testing important RST directives."""

__version__ = "0.1.0"
__all__ = ["initialize", "finalize"]


def initialize(config_path: str) -> None:
    """
    Initialize the system from a configuration file.

    Parameters
    ----------
    config_path
        The path to the configuration file.

    Returns
    -------
    None

    .. important::
        Must be called before any other function.
    """
    pass


def finalize() -> None:
    """
    Finalize the system and flush pending operations.

    Returns
    -------
    None

    .. important::
        Call this to flush all pending operations.
    """
    pass

📄 README.md

# gdtest-rst-important

Tests important RST directives in docstrings.

📄 great-docs.yml

parser: sphinx