gdtest-config-ug-string

Test package for user_guide string config.

Installation

pip install gdtest-config-ug-string

Get Started

API Reference — Full API documentation
User Guide — Guides and tutorials

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")
    """
    pass

📁 guides/

📄 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