Add --schema-file option to internal drivers (#592)

Author: maddenp-cu

docs/conf.py

@@ -14,6 +14,7 @@
 autodoc_mock_imports = ["f90nml", "iotaa", "jsonschema", "lxml", "referencing"]
 autodoc_typehints = "description"
 copyright = str(dt.datetime.now().year)
+exclude_patterns = ["**/shared/*.rst"]
 extensions = ["sphinx.ext.autodoc", "sphinx.ext.extlinks", "sphinx.ext.intersphinx"]
 extlinks_detect_hardcoded_links = True
 html_logo = os.path.join("static", "ufs.png")

docs/sections/user_guide/cli/Makefile

@@ -1,4 +1,4 @@
-SUBDIRS = $(shell find . -maxdepth 1 -mindepth 1 -type d)
+SUBDIRS = $(shell find . -maxdepth 1 -mindepth 1 -type d | sort)
 
 .PHONY: all $(SUBDIRS)
 

docs/sections/user_guide/cli/drivers/Makefile

@@ -0,0 +1,8 @@
+SUBDIRS = $(filter-out ./shared,$(shell find . -maxdepth 1 -mindepth 1 -type d | sort))
+
+.PHONY: all $(SUBDIRS)
+
+all: $(SUBDIRS)
+
+$(SUBDIRS):
+	$(MAKE) -C $@ -j

docs/sections/user_guide/cli/drivers/Makefile

@@ -0,0 +1 @@
+../shared/help.rst

docs/sections/user_guide/cli/drivers/cdeps/help.rst

@@ -1,23 +1,11 @@
 ``cdeps``
 =========
 
-.. include:: /shared/idempotent.rst
+.. include:: ../shared/idempotent.rst
 
 The ``uw`` mode for configuring and running the :CDEPS:`cdeps<>` component.
 
-.. literalinclude:: cdeps/help.cmd
-   :language: text
-   :emphasize-lines: 1
-.. literalinclude:: cdeps/help.out
-   :language: text
-
-All tasks take the same arguments. For example:
-
-.. literalinclude:: cdeps/run-help.cmd
-   :language: text
-   :emphasize-lines: 1
-.. literalinclude:: cdeps/run-help.out
-   :language: text
+.. include:: help.rst
 
 Examples
 ^^^^^^^^
@@ -45,10 +33,4 @@ Its contents are described in depth in section :ref:`cdeps_yaml`. Each of the va
 
 .. include:: /shared/key_path.rst
 
-* Specifying the ``--show-schema`` flag, with no other options, prints the driver's schema:
-
-.. literalinclude:: cdeps/show-schema.cmd
-   :language: text
-   :emphasize-lines: 1
-.. literalinclude:: cdeps/show-schema.out
-   :language: text
+.. include:: schema-options.rst

docs/sections/user_guide/cli/drivers/cdeps.rst renamed to docs/sections/user_guide/cli/drivers/cdeps/index.rst

@@ -1,6 +1,6 @@
 usage: uw cdeps atm --cycle CYCLE [-h] [--version] [--config-file PATH]
                     [--dry-run] [--graph-file PATH] [--key-path KEY[.KEY...]]
-                    [--quiet] [--verbose]
+                    [--schema-file PATH] [--quiet] [--verbose]
 
 The data atmosphere configuration with all required content
 
@@ -22,6 +22,8 @@ Optional arguments:
   --key-path KEY[.KEY...]
       Dot-separated path of keys leading through the config to the driver's
       configuration block
+  --schema-file PATH
+      Path to schema file to use for validation
   --quiet, -q
       Print no logging messages
   --verbose, -v

docs/sections/user_guide/cli/drivers/cdeps/run-help.out

@@ -0,0 +1 @@
+../shared/schema-options.rst

docs/sections/user_guide/cli/drivers/cdeps/schema-options.rst

@@ -0,0 +1 @@
+../shared/help.rst

docs/sections/user_guide/cli/drivers/chgres_cube/help.rst

@@ -1,23 +1,11 @@
 ``chgres_cube``
 ===============
 
-.. include:: /shared/idempotent.rst
+.. include:: ../shared/idempotent.rst
 
 The ``uw`` mode for configuring and running the :ufs-utils:`chgres_cube<chgres-cube>` component.
 
-.. literalinclude:: chgres_cube/help.cmd
-   :language: text
-   :emphasize-lines: 1
-.. literalinclude:: chgres_cube/help.out
-   :language: text
-
-All tasks take the same arguments. For example:
-
-.. literalinclude:: chgres_cube/run-help.cmd
-   :language: text
-   :emphasize-lines: 1
-.. literalinclude:: chgres_cube/run-help.out
-   :language: text
+.. include:: help.rst
 
 Examples
 ^^^^^^^^
@@ -59,10 +47,4 @@ Its contents are described in depth in section :ref:`chgres_cube_yaml`. Each of
 
      $ uw chgres_cube provisioned_rundir --config-file config.yaml --cycle 2023-12-15T18 --batch
 
-* Specifying the ``--show-schema`` flag, with no other options, prints the driver's schema:
-
-.. literalinclude:: chgres_cube/show-schema.cmd
-   :language: text
-   :emphasize-lines: 1
-.. literalinclude:: chgres_cube/show-schema.out
-   :language: text
+.. include:: schema-options.rst