From 85e92a5aec9574f1e59a36c31300a40ca071f965 Mon Sep 17 00:00:00 2001 From: Paul Madden Date: Tue, 28 Jan 2025 20:31:42 +0000 Subject: [PATCH] Remove troublesome gnu.org link from docs --- docs/conf.py | 1 - docs/sections/user_guide/cli/tools/config.rst | 10 +++++----- docs/sections/user_guide/cli/tools/template.rst | 6 +++--- 3 files changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index e8f721ed2..0c7dacd15 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -63,7 +63,6 @@ "rtd": ("https://readthedocs.org/projects/uwtools/%s", "%s"), "schism": ("https://schism-dev.github.io/schism/master/%s", "%s"), "sfc-climo-gen": ("https://ufs-community.github.io/UFS_UTILS/sfc_climo_gen/%s", "%s"), - "shell-redirection": ("https://www.gnu.org/software/bash/manual/html_node/Redirections.html%s", "%s"), "ufs": ("https://ufs.epic.noaa.gov/%s", "%s"), "ufs-utils": ("https://noaa-emcufs-utils.readthedocs.io/en/latest/ufs_utils.html#%s", "%s"), "ufs-weather-model": ("https://github.com/ufs-community/ufs-weather-model/%s", "%s"), diff --git a/docs/sections/user_guide/cli/tools/config.rst b/docs/sections/user_guide/cli/tools/config.rst index f86ce8c16..d5b3498af 100644 --- a/docs/sections/user_guide/cli/tools/config.rst +++ b/docs/sections/user_guide/cli/tools/config.rst @@ -72,7 +72,7 @@ The examples that follow use identical namelist files ``a.nml`` and ``b.nml`` wi .. literalinclude:: config/compare-verbose.out :language: text - Note that ``uw`` logs to ``stderr``. Use :shell-redirection:`shell redirection<>` as needed. + Note that ``uw`` logs to ``stderr``. Use shell redirection as needed. .. note:: Comparisons are supported only for configs of the same format, e.g. YAML vs YAML, Fortran namelist vs Fortran namelist, etc. ``uw`` will flag invalid comparisons: @@ -123,7 +123,7 @@ and YAML file ``update.yaml`` with contents: .. literalinclude:: config/realize-stdout.out :language: text - :shell-redirection:`Shell redirection<>` may also be used to stream output to a file, another process, etc. + Shell redirection may also be used to stream output to a file, another process, etc. * Values in the input file can be updated via an optional update file: @@ -264,7 +264,7 @@ and YAML file ``update.yaml`` with contents: .. literalinclude:: config/realize-verbose.out :language: text - Note that ``uw`` logs to ``stderr`` and writes non-log output to ``stdout``, so the streams can be redirected separately via :shell-redirection:`shell redirection<>`. + Note that ``uw`` logs to ``stderr`` and writes non-log output to ``stdout``, so the streams can be redirected separately via shell redirection. .. _cli_config_validate_examples: @@ -300,7 +300,7 @@ and the YAML file ``values.yaml`` with contents: .. literalinclude:: config/validate-pass.out :language: text - :shell-redirection:`Shell redirection<>` may also be used to stream output to a file, another process, etc. + Shell redirection may also be used to stream output to a file, another process, etc. * To read the *config* from ``stdin`` and print validation results to ``stdout``: @@ -328,4 +328,4 @@ and the YAML file ``values.yaml`` with contents: .. literalinclude:: config/validate-verbose.out :language: text - Note that ``uw`` logs to ``stderr``, so the stream can be :shell-redirection:`redirected<>`. + Note that ``uw`` logs to ``stderr``, so the stream can be redirected. diff --git a/docs/sections/user_guide/cli/tools/template.rst b/docs/sections/user_guide/cli/tools/template.rst index cd931e50f..97a6d56f0 100644 --- a/docs/sections/user_guide/cli/tools/template.rst +++ b/docs/sections/user_guide/cli/tools/template.rst @@ -49,7 +49,7 @@ and a YAML file called ``values.yaml`` with contents: .. literalinclude:: template/render-exec-stdout.out :language: text - :shell-redirection:`Shell redirection<>` may also be used to stream output to a file, another process, etc. + Shell redirection may also be used to stream output to a file, another process, etc. * To render the template to a file via command-line argument: @@ -99,7 +99,7 @@ and a YAML file called ``values.yaml`` with contents: .. literalinclude:: template/render-exec-verbose.out :language: text - Note that ``uw`` logs to ``stderr``. Use :shell-redirection:`shell redirection<>` as needed. + Note that ``uw`` logs to ``stderr``. Use shell redirection as needed. * The following examples use the YAML file ``greeting.yaml`` with contents: @@ -213,7 +213,7 @@ The examples in this section use atparse-formatted template file ``atparse.txt`` .. literalinclude:: template/translate-exec-stdout.out :language: text - :shell-redirection:`Shell redirection<>` may also be used to stream output to a file, another process, etc. + Shell redirection may also be used to stream output to a file, another process, etc. * To convert the template to a file via command-line argument: