Add basic documentation

askimed · Jun 13, 2024 · 6aba845 · 6aba845
1 parent f7b4d41
commit 6aba845
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/docs/cli/coverage.md b/docs/docs/cli/coverage.md
@@ -0,0 +1,19 @@
+# `coverage` command
+
+:octicons-tag-24: 0.9.0
+
+## Usage
+
+```
+nf-test coverage
+```
+
+The `coverage` command prints information about the number of Nextflow files that are covered by a test.
+
+### Optional Arguments
+
+#### `--csv <filename>`
+Writes a coverage report in csv format.
+
+#### `--html <filename>`
+Writes a coverage report in html format.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -59,6 +59,7 @@ nav:
           - generate: docs/cli/generate.md
           - test: docs/cli/test.md
           - list: docs/cli/list.md
+          - coverage: docs/cli/coverage.md
           - clean: docs/cli/clean.md
       - Configuration: docs/configuration.md
       - Plugins: