-
Notifications
You must be signed in to change notification settings - Fork 196
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[automated] Update nf-core/tools API docs for dev
- Loading branch information
1 parent
56363e8
commit cd4ed66
Showing
39 changed files
with
1,297 additions
and
104 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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]() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
34 changes: 34 additions & 0 deletions
34
sites/docs/src/content/api_reference/dev/api/pipelines/bump_version.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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) → None{: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) → None{: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]]) → None{: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
71
sites/docs/src/content/api_reference/dev/api/pipelines/create.md
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.