#112
gdtest_config_ug_string
OK
CONFIG
Tests user_guide config as a string pointing to a custom 'guides' directory.
Tests user_guide: 'guides' (string pointing to custom dir). User guide pages live in guides/ instead of user_guide/. Sidebar should show them.
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
K19
K19user_guide: stringconfig
Source Files
gdtest_config_ug_string/
__init__.py
"""Test package for user_guide string config."""
core.py
"""Core I/O functions."""
def load(path: str) -> dict:
"""Load data from a file.
Parameters
----------
path : str
The file path to load data from.
Returns
-------
dict
The loaded data as a dictionary.
Examples
--------
>>> load("data.json")
{'key': 'value'}
"""
return {}
def save(data: dict, path: str) -> None:
"""Save data to a file.
Parameters
----------
data : dict
The data to save.
path : str
The file path to save data to.
Examples
--------
>>> save({"key": "value"}, "data.json")
"""
passguides/
intro.qmd
--- title: Introduction --- # Introduction Welcome to the guides.
setup.qmd
--- title: Setup --- # Setup How to set up the project.
great-docs.yml
user_guide: guides