Skip to content

Commit

Permalink
add subworkflows lint docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mirpedrol committed Jul 27, 2023
1 parent 69e7f8b commit 5ea3b08
Show file tree
Hide file tree
Showing 8 changed files with 40 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/api/_src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ This documentation is for the `nf-core/tools` package.

- [Pipeline code lint tests](pipeline_lint_tests/index.md) (run by `nf-core lint`)
- [Module code lint tests](module_lint_tests/index.md) (run by `nf-core modules lint`)
- [Subworkflow code lint tests](subworkflow_lint_test/index.mf) (run by `nf-core subworkflows lint`)
- [nf-core/tools Python package API reference](api/index.md)
- {ref}`genindex`
- {ref}`modindex`
9 changes: 9 additions & 0 deletions docs/api/_src/subworkflow_lint_tests/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Subworkflow lint tests

```{toctree}
:caption: 'Tests:'
:glob: true
:maxdepth: 2
*
```
5 changes: 5 additions & 0 deletions docs/api/_src/subworkflow_lint_tests/main_nf.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# main_nf

```{eval-rst}
.. automethod:: nf_core.subworkflows.lint.SubworkflowLint.main_nf
```
5 changes: 5 additions & 0 deletions docs/api/_src/subworkflow_lint_tests/meta_yml.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# meta_yml

```{eval-rst}
.. automethod:: nf_core.subworkflows.lint.SubworkflowLint.meta_yml
```
5 changes: 5 additions & 0 deletions docs/api/_src/subworkflow_lint_tests/module_changes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# module_changes

```{eval-rst}
.. automethod:: nf_core.subworkflows.lint.SubworkflowLint.module_changes
```
5 changes: 5 additions & 0 deletions docs/api/_src/subworkflow_lint_tests/module_tests.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# module_tests

```{eval-rst}
.. automethod:: nf_core.subworkflows.lint.SubworkflowLint.module_tests
```
5 changes: 5 additions & 0 deletions docs/api/_src/subworkflow_lint_tests/module_todos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# module_todos

```{eval-rst}
.. automethod:: nf_core.subworkflows.lint.SubworkflowLint.module_todos
```
5 changes: 5 additions & 0 deletions docs/api/_src/subworkflow_lint_tests/module_version.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# module_version

```{eval-rst}
.. automethod:: nf_core.subworkflows.lint.SubworkflowLint.module_version
```

0 comments on commit 5ea3b08

Please sign in to comment.