Skip to content

Commit

Permalink
[automated] Update nf-core/tools API docs for dev
Browse files Browse the repository at this point in the history
  • Loading branch information
nf-core-bot committed Aug 29, 2024
1 parent a85250a commit 9156e8e
Show file tree
Hide file tree
Showing 31 changed files with 1,261 additions and 92 deletions.
22 changes: 21 additions & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 5 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,11 @@
"update": "for dir in sites/*; do (cd $dir && npx ncu --interactive --format group); done",
"test-all": "for dir in sites/*; do (cd $dir && npm run test); done"
},
"devDependencies": {
},
"workspaces": [
"sites/*"
]
],
"dependencies": {
"remark": "^15.0.1",
"unist-util-visit": "^5.0.0"
}
}
24 changes: 10 additions & 14 deletions sites/docs/src/content/api_reference/dev/api/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
# API Reference
# nf-core/tools documentation

- [nf_core.bump_version](bump_version)
- [nf_core.create](create)
- [nf_core.download](download)
- [nf_core.launch](launch)
- [nf_core.licences](licences)
- [nf_core.lint](lint)
- [nf_core.list](list)
- [nf_core.modules](modules)
- [nf_core.params_file](params-file)
- [nf_core.schema](schema)
- [nf_core.subworkflows](subworkflows)
- [nf_core.sync](sync)
- [nf_core.utils](utils)
This API documentation is for the [`nf-core/tools`](https://github.com/nf-core/tools) package.

## Contents

- [Pipeline commands]() (run by `nf-core pipelines lint`)
- [Module commands]() (run by `nf-core modules lint`)
- [Subworkflow commands]() (run by `nf-core subworkflows lint`)
- [nf-core/tools Python package API reference]()
- [nf-core/tools pipeline commands API referece]()
2 changes: 2 additions & 0 deletions sites/docs/src/content/api_reference/dev/api/lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,8 +127,10 @@ Helper function to take a list of filenames and format with markdown.

- **Returns:**
Formatted string of paths separated by word `or`, eg:

```default
`foo` or bar` or `baz`
```

- **Return type:**
markdown (str)
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# nf_core.bump_version

Bumps the version number in all appropriate files for
a nf-core pipeline.

### `nf_core.pipelines.bump_version.bump_nextflow_version(pipeline_obj: Pipeline, new_version: str){:python}`

Bumps the required Nextflow version number of a pipeline.

- **Parameters:**
- **pipeline_obj** (_nf_core.utils.Pipeline_) – A Pipeline object that holds information
about the pipeline contents and build files.
- **new_version** (_str_) – The new version tag for the required Nextflow version.

### `nf_core.pipelines.bump_version.bump_pipeline_version(pipeline_obj: Pipeline, new_version: str){:python}`

Bumps a pipeline version number.

- **Parameters:**
- **pipeline_obj** (_nf_core.utils.Pipeline_) – A Pipeline object that holds information
about the pipeline contents and build files.
- **new_version** (_str_) – The new version tag for the pipeline. Semantic versioning only.

### `nf_core.pipelines.bump_version.update_file_version(filename: str | Path, pipeline_obj: Pipeline, patterns: List[Tuple[str, str]]){:python}`

Updates the version number in a requested file.

- **Parameters:**
- **filename** (_str_) – File to scan.
- **pipeline_obj** (_nf_core.pipelines.lint.PipelineLint_) – A PipelineLint object that holds information
about the pipeline contents and build files.
- **pattern** (_str_) – Regex pattern to apply.
- **Raises:**
**ValueError**\*\*,\*\* **if the version number cannot be found.**
71 changes: 71 additions & 0 deletions sites/docs/src/content/api_reference/dev/api/pipelines/create.md

Large diffs are not rendered by default.

Loading

0 comments on commit 9156e8e

Please sign in to comment.