add doc page

chanzuckerberg · Aug 8, 2023 · 3874aab · 3874aab
1 parent 01c7ece
commit 3874aab
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,6 +13,7 @@ the bioinformatics-focused `Workflow Description Language (WDL) <http://openwdl.
    runner_advanced.md
    runner_backends.md
    check.rst
+   input_template.rst
    zip.rst
    FAQ.md
    WDL.rst

diff --git a/docs/input_template.rst b/docs/input_template.rst
@@ -0,0 +1,24 @@
+``miniwdl input_template``
+===============
+
+``miniwdl input_template`` generates a JSON skeleton for the inputs required to run a given WDL. Once the template is filled out, the JSON can be used with `miniwdl run ... -i INPUT.json`.
+
+.. code-block:: bash
+
+   $ miniwdl input-template path/to/my.wdl > my_inputs.json
+   $ vim my_inputs.json  # edit template
+   $ miniwdl run path/to/my.wdl -i my_inputs.json
+
+Currently, the template includes only the WDL's required inputs (not the optional ones).
+
+
+Command line
+------------
+
+.. argparse::
+   :module: WDL.CLI
+   :func: create_arg_parser
+   :prog: miniwdl
+   :path: input_template
+   :nodescription:
+   :nodefaultconst: