Skip to content

Commit

Permalink
Remove troublesome gnu.org link from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maddenp-noaa committed Jan 28, 2025
1 parent a64e8e7 commit 85e92a5
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 9 deletions.
1 change: 0 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand Down
10 changes: 5 additions & 5 deletions docs/sections/user_guide/cli/tools/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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``:

Expand Down Expand Up @@ -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.
6 changes: 3 additions & 3 deletions docs/sections/user_guide/cli/tools/template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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:

Expand Down

0 comments on commit 85e92a5

Please sign in to comment.