#153
gdtest_ug_custom_dir
OK
CONFIG
User guide in docs/ directory instead of user_guide/ via config.
User guide lives in docs/ instead of user_guide/. Config sets user_guide: 'docs'. Sidebar should find pages from the custom dir.
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
M5
M5Custom UG diruser_guide
Source Files
docs/
getting-started.qmd
--- title: Getting Started --- # Getting Started A guide to getting started with the library.
reference-guide.qmd
--- title: Reference Guide --- # Reference Guide A comprehensive reference guide for all features.
gdtest_ug_custom_dir/
__init__.py
"""Test package for custom user guide directory."""
core.py
"""Core load/save functions."""
def load(path: str) -> dict:
"""Load data from the given file path.
Parameters
----------
path : str
The path to load data from.
Returns
-------
dict
The loaded data as a dictionary.
Examples
--------
>>> load("config.json")
{'key': 'value'}
"""
return {}
def save(data: dict) -> None:
"""Save data to persistent storage.
Parameters
----------
data : dict
The data to save.
Examples
--------
>>> save({"key": "value"})
"""
passgreat-docs.yml
user_guide: docs