Skip to content

Commit 924542f

Browse files
committed
Bump docs 22.10.2
Signed-off-by: Paolo Di Tommaso <[email protected]>
1 parent 76ea977 commit 924542f

39 files changed

+87
-68
lines changed

assets/docs/latest/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: fdbdef3fba1ce98e7aa920e375e9caf6
3+
config: 15e369f31649ef6891b0e6925783b56f
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

assets/docs/latest/_sources/config.rst.txt

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -244,15 +244,16 @@ useMicromamba uses the ``micromamba`` binary instead of ``conda`` to creat
244244
Scope `dag`
245245
-------------
246246

247-
The ``dag`` scope allows you to control the layout of the execution graph file generated by Nextflow.
247+
The ``dag`` scope allows you to control the layout of the execution graph diagram generated by Nextflow.
248248

249249
The following settings are available:
250250

251251
================== ================
252252
Name Description
253253
================== ================
254-
enabled When ``true`` turns on the generation of the execution graph report file (default: ``false``).
255-
file Graph file name (default: ``dag.dot``).
254+
enabled When ``true`` turns on the generation of the DAG file (default: ``false``).
255+
file Graph file name (default: ``dag-<timestamp>.dot``).
256+
overwrite When ``true`` overwrites any existing DAG file with the same name.
256257
================== ================
257258

258259
The above options can be used by prefixing them with the ``dag`` scope or surrounding them by curly
@@ -730,8 +731,8 @@ The ``report`` scope allows you to define configuration setting of the workflow
730731
Name Description
731732
================== ================
732733
enabled If ``true`` it create the workflow execution report.
733-
file The path of the created execution report file (default: ``report.html``).
734-
overwrite When ``true`` overwrites existing report file instead of rolling it.
734+
file The path of the created execution report file (default: ``report-<timestamp>.html``).
735+
overwrite When ``true`` overwrites any existing report file with the same name.
735736
================== ================
736737

737738

@@ -793,8 +794,8 @@ The following settings are available:
793794
Name Description
794795
================== ================
795796
enabled When ``true`` turns on the generation of the timeline report file (default: ``false``).
796-
file Timeline file name (default: ``timeline.html``).
797-
overwrite When ``true`` overwrites an existing timeline file instead of rolling it.
797+
file Timeline file name (default: ``timeline-<timestamp>.html``).
798+
overwrite When ``true`` overwrites any existing timeline file with the same name.
798799
================== ================
799800

800801

@@ -846,10 +847,10 @@ Name Description
846847
================== ================
847848
enabled When ``true`` turns on the generation of the execution trace report file (default: ``false``).
848849
fields Comma separated list of fields to be included in the report. The available fields are listed at :ref:`this page <trace-fields>`
849-
file Trace file name (default: ``trace.txt``).
850+
file Trace file name (default: ``trace-<timestamp>.txt``).
850851
sep Character used to separate values in each row (default: ``\t``).
851852
raw When ``true`` turns on raw number report generation i.e. date and time are reported as milliseconds and memory as number of bytes
852-
overwrite When ``true`` overwrites an existing trace file instead of rolling it.
853+
overwrite When ``true`` overwrites any existing trace file with the same name.
853854
================== ================
854855

855856
The above options can be used by prefixing them with the ``trace`` scope or surrounding them by curly

assets/docs/latest/_sources/process.rst.txt

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -632,6 +632,9 @@ with the current execution context.
632632
own directory, and input files are automatically staged into this directory by Nextflow.
633633
This behavior guarantees that input files with the same name won't overwrite each other.
634634

635+
An example of when you may have to deal with that is when you have many input files in a task,
636+
and some of these files may have the same filename. In this case, a solution would be to use
637+
the option ``stageAs``.
635638

636639
Input type ``env``
637640
------------------
@@ -1092,6 +1095,11 @@ on the actual value of the ``species`` input.
10921095
Also, metadata can be associated with outputs by using the :ref:`tuple output <process-out-tuple>` qualifier, instead of
10931096
including them in the output file name.
10941097

1098+
One example in which you'd need to manage the naming of output files is when you use the ``publishDir`` directive
1099+
to have output files also in a specific path of your choice. If two tasks have the same filename for their output and you want them
1100+
to be in the same path specified by ``publishDir``, the last task to finish will overwrite the output of the task that finished before.
1101+
You can dynamically change that by adding the ``saveAs`` option to your ``publishDir`` directive.
1102+
10951103
To sum up, the use of output files with static names over dynamic ones is preferable whenever possible,
10961104
because it will result in simpler and more portable code.
10971105

@@ -1974,7 +1982,7 @@ saveAs A closure which, given the name of the file being published, ret
19741982
enabled Enable or disable the publish rule depending on the boolean value specified (default: ``true``).
19751983
failOnError When ``true`` abort the execution if some file can't be published to the specified target directory or bucket for any cause (default: ``false``)
19761984
contentType Allow specifying the media content type of the published file a.k.a. `MIME type <https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_Types>`_. If the boolean value ``true`` is specified the content type is inferred from the file extension (EXPERIMENTAL. Currently only supported by files stored on AWS S3. Default: ``false``, requires `22.10.0`` or later).
1977-
tags Allow the association of arbitrary tags with the published file e.g. ``tag: [FOO: 'Hello world']`` (EXPERIMENTAL. Currently only supported by files stored on AWS S3. Requires version ``21.12.0-edge`` or later).
1985+
tags Allow the association of arbitrary tags with the published file e.g. ``tags: [FOO: 'Hello world']`` (EXPERIMENTAL. Currently only supported by files stored on AWS S3. Requires version ``21.12.0-edge`` or later).
19781986
=============== =================
19791987

19801988
Table of publish modes:

assets/docs/latest/_sources/script.rst.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -251,11 +251,11 @@ The following variables are implicitly defined in the ``task`` object of each pr
251251
Name Description
252252
=============== ========================
253253
``attempt`` The current task attempt
254-
``hash`` The task unique hash Id
254+
``hash`` The task unique hash Id. NOTE: This is only available for processes that run native code via ``exec:``.
255255
``index`` The task index (corresponds to ``task_id`` in the execution trace)
256-
``name`` The current task name
256+
``name`` The current task name. NOTE: This is only available for processes that run native code via ``exec:``.
257257
``process`` The current process name
258-
``workDir`` The task unique directory. NOTE: This is only available for processes that run native code via the ``exec:`` statement.
258+
``workDir`` The task unique directory. NOTE: This is only available for processes that run native code via ``exec:``.
259259
=============== ========================
260260

261261
The ``task`` object also contains the values of all process directives for the given task,

assets/docs/latest/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '22.10.1',
3+
VERSION: '22.10.2',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

assets/docs/latest/amazons3.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Amazon S3 storage &mdash; Nextflow 22.10.1 documentation</title>
7+
<title>Amazon S3 storage &mdash; Nextflow 22.10.2 documentation</title>
88
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
1010
<link rel="stylesheet" href="_static/theme.css" type="text/css" />

assets/docs/latest/aws.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Amazon Cloud &mdash; Nextflow 22.10.1 documentation</title>
7+
<title>Amazon Cloud &mdash; Nextflow 22.10.2 documentation</title>
88
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
1010
<link rel="stylesheet" href="_static/theme.css" type="text/css" />

assets/docs/latest/azure.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Azure Cloud &mdash; Nextflow 22.10.1 documentation</title>
7+
<title>Azure Cloud &mdash; Nextflow 22.10.2 documentation</title>
88
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
1010
<link rel="stylesheet" href="_static/theme.css" type="text/css" />

assets/docs/latest/basic.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Basic concepts &mdash; Nextflow 22.10.1 documentation</title>
7+
<title>Basic concepts &mdash; Nextflow 22.10.2 documentation</title>
88
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
1010
<link rel="stylesheet" href="_static/theme.css" type="text/css" />

assets/docs/latest/channel.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Channels &mdash; Nextflow 22.10.1 documentation</title>
7+
<title>Channels &mdash; Nextflow 22.10.2 documentation</title>
88
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
1010
<link rel="stylesheet" href="_static/theme.css" type="text/css" />

0 commit comments

Comments
 (0)