Skip to content

Commit

Permalink
Merge pull request #2779 from nf-core/update-api-docs-3.0.1
Browse files Browse the repository at this point in the history
Update nf-core/tools API docs for 3.0.1
  • Loading branch information
mashehu authored Oct 9, 2024
2 parents 836a488 + 6fe91d9 commit 6d26549
Show file tree
Hide file tree
Showing 58 changed files with 3,139 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.autodoc_pydantic_validator_arrow {
padding-left: 8px;
}

.autodoc_pydantic_collapsable_json {
cursor: pointer;
}

.autodoc_pydantic_collapsable_erd {
cursor: pointer;
}
11 changes: 11 additions & 0 deletions sites/docs/src/content/api_reference/3.0.1/api/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# nf-core/tools documentation

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]()
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:{:python}`[`Pipeline{:python}`](../utils#nf_core.utils.Pipeline)`, new_version: str) → None{:python}`

Bumps the required Nextflow version number of a pipeline.

- **Parameters:**
- **pipeline_obj** ([_nf_core.utils.Pipeline_](../utils#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:{:python}`[`Pipeline{:python}`](../utils#nf_core.utils.Pipeline)`, new_version: str) → None{:python}`

Bumps a pipeline version number.

- **Parameters:**
- **pipeline_obj** ([_nf_core.utils.Pipeline_](../utils#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:{:python}`[`Pipeline{:python}`](../utils#nf_core.utils.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 sites/docs/src/content/api_reference/3.0.1/api/pipelines/create.md

Large diffs are not rendered by default.

Loading

0 comments on commit 6d26549

Please sign in to comment.