Merge pull request #2384 from mirpedrol/subworkflows-lint

This will hopefully generate lint API docs 🤞
nf-core · Jul 28, 2023 · 13f331e · 13f331e
2 parents ab34a79 + 3878f44
commit 13f331e
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 25 deletions.
diff --git a/docs/api/_src/index.md b/docs/api/_src/index.md
@@ -8,6 +8,7 @@
 
 pipeline_lint_tests/index.rst
 module_lint_tests/index.rst
+subworkflow_lint_tests/index.rst
 api/index.rst
 ```
 
@@ -17,7 +18,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`)
+- [Subworkflow code lint tests](subworkflow_lint_tests/index.md) (run by `nf-core subworkflows lint`)
 - [nf-core/tools Python package API reference](api/index.md)
 - {ref}`genindex`
 - {ref}`modindex`
diff --git a/docs/api/_src/subworkflow_lint_tests/module_changes.md b/docs/api/_src/subworkflow_lint_tests/module_changes.md
diff --git a/docs/api/_src/subworkflow_lint_tests/module_tests.md b/docs/api/_src/subworkflow_lint_tests/module_tests.md
diff --git a/docs/api/_src/subworkflow_lint_tests/module_todos.md b/docs/api/_src/subworkflow_lint_tests/module_todos.md
diff --git a/docs/api/_src/subworkflow_lint_tests/module_version.md b/docs/api/_src/subworkflow_lint_tests/module_version.md
diff --git a/docs/api/_src/subworkflow_lint_tests/subworkflow_changes.md b/docs/api/_src/subworkflow_lint_tests/subworkflow_changes.md
@@ -0,0 +1,5 @@
+# subworkflow_changes
+
+```{eval-rst}
+.. automethod:: nf_core.subworkflows.lint.SubworkflowLint.subworkflow_changes
+```
diff --git a/docs/api/_src/subworkflow_lint_tests/subworkflow_tests.md b/docs/api/_src/subworkflow_lint_tests/subworkflow_tests.md
@@ -0,0 +1,5 @@
+# subworkflow_tests
+
+```{eval-rst}
+.. automethod:: nf_core.subworkflows.lint.SubworkflowLint.subworkflow_tests
+```
diff --git a/docs/api/_src/subworkflow_lint_tests/subworkflow_todos.md b/docs/api/_src/subworkflow_lint_tests/subworkflow_todos.md
@@ -0,0 +1,5 @@
+# subworkflow_todos
+
+```{eval-rst}
+.. automethod:: nf_core.subworkflows.lint.SubworkflowLint.subworkflow_todos
+```
diff --git a/docs/api/_src/subworkflow_lint_tests/subworkflow_version.md b/docs/api/_src/subworkflow_lint_tests/subworkflow_version.md
@@ -0,0 +1,5 @@
+# subworkflow_version
+
+```{eval-rst}
+.. automethod:: nf_core.subworkflows.lint.SubworkflowLint.subworkflow_version
+```
diff --git a/docs/api/make_lint_md.py b/docs/api/make_lint_md.py
@@ -45,8 +45,8 @@ def make_docs(docs_basedir, lint_tests, md_template):
 make_docs(
     modules_docs_basedir,
     list(
-        set(nf_core.modules.lint.ModuleLint.get_all_lint_tests(is_pipeline=True)).union(
-            nf_core.modules.lint.ModuleLint.get_all_lint_tests(is_pipeline=False)
+        set(nf_core.modules.lint.ModuleLint.get_all_module_lint_tests(is_pipeline=True)).union(
+            nf_core.modules.lint.ModuleLint.get_all_module_lint_tests(is_pipeline=False)
         )
     ),
     """# {0}
@@ -62,8 +62,8 @@ def make_docs(docs_basedir, lint_tests, md_template):
 make_docs(
     subworkflows_docs_basedir,
     list(
-        set(nf_core.subworkflows.lint.SubworkflowLint.get_all_lint_tests(is_pipeline=True)).union(
-            nf_core.subworkflows.lint.SubworkflowLint.get_all_lint_tests(is_pipeline=False)
+        set(nf_core.subworkflows.lint.SubworkflowLint.get_all_subworkflow_lint_tests(is_pipeline=True)).union(
+            nf_core.subworkflows.lint.SubworkflowLint.get_all_subworkflow_lint_tests(is_pipeline=False)
         )
     ),
     """# {0}