Skip to content

Commit 9e38a32

Browse files
committed
Updates
1 parent 2dffbd3 commit 9e38a32

File tree

4 files changed

+4
-4
lines changed

4 files changed

+4
-4
lines changed

docs/sections/contributor_guide/developer_setup.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Creating a ``bash`` Development Shell
66

77
If an existing conda (:miniforge:`Miniforge<>`, :miniconda:`Miniconda<>`, :anaconda:`Anaconda<>`, etc.) installation is available and writable, step 1 may be skipped.
88

9-
.. include:: /shared/miniforge_instructions.rst
9+
#. .. include:: /shared/miniforge_instructions.rst
1010

1111
#. Install the :anaconda-condev:`condev package<>` into the ``base`` environment.
1212

docs/sections/user_guide/cli/tools/execute.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The ``uw`` mode for executing external drivers.
1111

1212
For the three required arguments:
1313

14-
* ``--module`` specifies the path to a ``.py`` file containing a UW driver class. The path may be: absolute (e.g. ``/path/to/driver.py``), in which case ``uw`` may be invoked from anywhere on the filesystem; relative to the shell's current directory (e.g. ``../driver.py``, ``sub/dir/driver.py``); or simply the filename (e.g. ``driver.py``) if the directory containing the module is added to ``PYTHONPATH``.
14+
* ``--module`` specifies the name of the module providing the driver. The name may be an absolute path (e.g. ``/path/to/driver.py``); a path relative to the current directory (e.g. ``driver.py``, ``../driver.py``, ``sub/dir/driver.py``); or a name appropriate to the Python ``import`` statement (e.g. ``driver``, ``my.package.driver``), provided the directory containing the module is on ``PYTHONPATH`` / ``sys.path``.
1515
* ``--class`` specifies the name of a class in the above module that implements the driver, which should use one of the classes exported by ``uwtools.api.driver`` as its base class.
1616
* ``--task`` specifies the name of a method in the above class that implements a :iotaa:`task<blob/main/README.md#tasks>`, decorated with :iotaa:`@task<blob/main/README.md#task>`, :iotaa:`@tasks<blob/main/README.md#tasks>`, or :iotaa:`@external<blob/main/README.md#external>`.
1717

docs/sections/user_guide/installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ To create a standalone conda environment providing ``uwtools``:
3838
Use a Fresh Miniforge Installation
3939
----------------------------------
4040

41-
.. include:: /shared/miniforge_instructions.rst
41+
#. .. include:: /shared/miniforge_instructions.rst
4242

4343
#. Continue with the `Use an Existing conda Installation`_ instructions.
4444

docs/shared/miniforge_instructions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#. Visit the :miniforge:`Miniforge releases page<releases/latest>` and obtain the URL and filename for the ``Miniforge3-[os]-[architecture].sh`` installer appropriate to your system, for example ``Miniforge3-Linux-x86_64.sh`` or ``Miniforge3-MacOSX-arm64.sh``. Download, install, and activate. Modify the ``$HOME/conda`` installation directory per your needs.
1+
Visit the :miniforge:`Miniforge releases page<releases/latest>` and obtain the URL and filename for the ``Miniforge3-[os]-[architecture].sh`` installer appropriate to your system, for example ``Miniforge3-Linux-x86_64.sh`` or ``Miniforge3-MacOSX-arm64.sh``. Download, install, and activate. Modify the ``$HOME/conda`` installation directory per your needs.
22

33
.. code-block:: text
44

0 commit comments

Comments
 (0)