From 38e4c7cdb8eaa5ff5a521de4de6584547ba99f76 Mon Sep 17 00:00:00 2001 From: Paul Madden <136389411+maddenp-noaa@users.noreply.github.com> Date: Wed, 4 Sep 2024 08:49:19 -0600 Subject: [PATCH] Add formatting to Copier/Linker/MakeDirs class docstrings for better API docs (#601) --- docs/sections/user_guide/api/index.rst | 2 ++ src/uwtools/fs.py | 8 ++++---- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/sections/user_guide/api/index.rst b/docs/sections/user_guide/api/index.rst index 2bdb3dbac..ba4bc9b77 100644 --- a/docs/sections/user_guide/api/index.rst +++ b/docs/sections/user_guide/api/index.rst @@ -2,6 +2,8 @@ API === .. toctree:: + :maxdepth: 1 + cdeps chgres_cube config diff --git a/src/uwtools/fs.py b/src/uwtools/fs.py index 5eb067099..9f9d539c4 100644 --- a/src/uwtools/fs.py +++ b/src/uwtools/fs.py @@ -35,13 +35,13 @@ def __init__( """ Stage files and directories. - :param config: YAML-file path, or dict (read stdin if missing or None). + :param config: YAML-file path, or ``dict`` (read ``stdin`` if missing or ``None``). :param target_dir: Path to target directory. - :param cycle: A datetime object to make available for use in the config. - :param leadtime: A timedelta object to make available for use in the config. + :param cycle: A ``datetime`` object to make available for use in the config. + :param leadtime: A ``timedelta`` object to make available for use in the config. :param keys: YAML keys leading to file dst/src block. :param dry_run: Do not copy files. - :raises: UWConfigError if config fails validation. + :raises: ``UWConfigError`` if config fails validation. """ dryrun(enable=dry_run) self._keys = keys or []