#127
gdtest_rst_note
OK
CONFIG
Tests note RST directives in docstrings
Docstrings contain '.. note::' with body text. The built-in handler should produce Quarto note callouts. Three functions have note blocks.
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
L3
L3.. note::docstring
Source Files
gdtest_rst_note/
__init__.py
"""Package testing note RST directives."""
__version__ = "0.1.0"
__all__ = ["configure", "reset_defaults", "get_config"]
def configure(settings: dict) -> None:
"""
Apply configuration settings.
Parameters
----------
settings
A dictionary of settings to apply.
Returns
-------
None
.. note::
Settings are validated before applying.
"""
pass
def reset_defaults() -> dict:
"""
Reset all settings to their default values.
Returns
-------
dict
The default settings.
.. note::
This restores factory settings.
"""
return {}
def get_config() -> dict:
"""
Retrieve the current configuration.
Returns
-------
dict
The current configuration dictionary.
.. note::
Returns a deep copy of the configuration.
"""
return {}README.md
# gdtest-rst-note Tests note RST directives in docstrings.
great-docs.yml
parser: sphinx