Skip to content

Commit 9a65d72

Browse files
committed
Bump docs 20.10.0
1 parent aba43a5 commit 9a65d72

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+146
-157
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: a0f65b699793b5f604c9b2e87fef2ccb
3+
config: 41c5d50fca96e9aee9092129b6bc013c
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -414,6 +414,7 @@ Name Description
414414
================== ================
415415
author Project author name (use a comma to separate multiple names).
416416
defaultBranch Git repository default branch (default: ``master``).
417+
recurseSubmodules Turn this flag to ``true`` to pull submodules recursively from the Git repository
417418
description Free text describing the workflow project.
418419
doi Project related publication DOI identifier.
419420
homePage Project home page URL.
@@ -809,6 +810,8 @@ NXF_OFFLINE When ``true`` disables the project automatic downloa
809810
NXF_CLOUD_DRIVER Defines the default cloud driver to be used if not specified in the config file or as command line option, either ``aws`` or ``google``.
810811
NXF_ANSI_LOG Enables/disables ANSI console output (default ``true`` when ANSI terminal is detected).
811812
NXF_ANSI_SUMMARY Enables/disables ANSI completion summary: `true|false` (default: print summary if execution last more than 1 minute).
813+
NXF_SCM_FILE Defines the path location of the SCM config file (requires version ``20.10.0`` or later).
814+
NXF_PARAMS_FILE Defines the path location of the pipeline parameters file (requires version ``20.10.0`` or later).
812815
JAVA_HOME Defines the path location of the Java VM installation used to run Nextflow.
813816
JAVA_CMD Defines the path location of the Java binary command used to launch Nextflow.
814817
HTTP_PROXY Defines the HTTP proxy server

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Requirements
1010
============
1111

1212
`Nextflow` can be used on any POSIX compatible system (Linux, OS X, etc).
13-
It requires Bash 3.2 (or later) and `Java 8 (or later, up to 11) <http://www.oracle.com/technetwork/java/javase/downloads/index.html>`_ to be installed.
13+
It requires Bash 3.2 (or later) and `Java 8 (or later, up to 15) <http://www.oracle.com/technetwork/java/javase/downloads/index.html>`_ to be installed.
1414

1515
For the execution in a cluster of computers the use a shared file system is required to allow
1616
the sharing of tasks input/output files.

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

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,3 @@ Contents:
3535
sharing
3636
metadata
3737
mail
38-
example

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

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1749,6 +1749,9 @@ To create a multi-map criteria as variable that can be passed as an argument to
17491749
into
17501750
----
17511751

1752+
.. warning::
1753+
The ``into`` operator is not available when using Nextflow DSL2 syntax.
1754+
17521755
The ``into`` operator connects a source channel to two or more target channels in such a way the values emitted by
17531756
the source channel are copied to the target channels. For example::
17541757

@@ -1799,18 +1802,26 @@ The ``tap`` can be useful in certain scenarios where you may be required to conc
17991802
as in the following example::
18001803

18011804

1802-
log1 = Channel.create().view { "Log 1: $it" }
1803-
log2 = Channel.create().view { "Log 2: $it" }
1805+
log1 = Channel.create()
1806+
log2 = Channel.create()
18041807

18051808
Channel
1806-
.from ( 'a', 'b', 'c' )
1807-
.tap( log1 )
1808-
.map { it * 2 }
1809-
.tap( log2 )
1810-
.view { "Result: $it" }
1809+
.of ( 'a', 'b', 'c' )
1810+
.tap ( log1 )
1811+
.map { it * 2 }
1812+
.tap ( log2 )
1813+
.map { it.toUpperCase() }
1814+
.view { "Result: $it" }
1815+
1816+
log1.view { "Log 1: $it" }
1817+
log2.view { "Log 2: $it" }
18111818

18121819
::
18131820

1821+
Result: AA
1822+
Result: BB
1823+
Result: CC
1824+
18141825
Log 1: a
18151826
Log 1: b
18161827
Log 1: c
@@ -1819,22 +1830,19 @@ as in the following example::
18191830
Log 2: bb
18201831
Log 2: cc
18211832

1822-
Result: aa
1823-
Result: bb
1824-
Result: cc
18251833

18261834
The ``tap`` operator also allows the target channel to be specified by using a closure. The advantage of this syntax
18271835
is that you won't need to previously create the target channel, because it is created implicitly by the operator itself.
18281836

18291837
Using the closure syntax the above example can be rewritten as shown below::
18301838

18311839
Channel
1832-
.from ( 'a', 'b', 'c' )
1833-
.tap { log1 }
1834-
.map { it * 2 }
1835-
.tap { log2 }
1836-
.view { "Result: $it" }
1837-
1840+
.of ( 'a', 'b', 'c' )
1841+
.tap { log1 }
1842+
.map { it * 2 }
1843+
.tap { log2 }
1844+
.map { it.toUpperCase() }
1845+
.view { "Result: $it" }
18381846

18391847
log1.view { "Log 1: $it" }
18401848
log2.view { "Log 2: $it" }
@@ -1846,7 +1854,7 @@ See also `into`_ and `separate`_ operators.
18461854
separate
18471855
--------
18481856

1849-
.. warning:: The `separate` operator has been deprecated. Use `multiMap`_ instead.
1857+
.. warning:: The ``separate`` operator has been deprecated. Use `multiMap`_ instead.
18501858

18511859
The ``separate`` operator lets you copy the items emitted by the source channel into multiple
18521860
channels, which each of these can receive a `separate` version of the same item.
@@ -2242,7 +2250,7 @@ print
22422250
------
22432251

22442252
.. warning::
2245-
The ``print`` operator is deprecated and not supported any more when using DLS2 syntax. Use
2253+
The ``print`` operator is deprecated and not supported any more when using DSL2 syntax. Use
22462254
`view`_ instead.
22472255

22482256
The ``print`` operator prints the items emitted by a channel to the standard output.
@@ -2265,7 +2273,7 @@ println
22652273
--------
22662274

22672275
.. warning::
2268-
The ``println`` operator is deprecated and not supported any more when using DLS2 syntax. Use
2276+
The ``println`` operator is deprecated and not supported any more when using DSL2 syntax. Use
22692277
`view`_ instead.
22702278

22712279
The ``println`` operator prints the items emitted by a channel to the console standard output appending

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,9 @@ Downloaded pipelines can be deleted by using the ``drop`` command, as shown belo
160160

161161
nextflow drop nextflow-io/hello
162162

163+
164+
.. _sharing-scm-file:
165+
163166
SCM configuration file
164167
=======================
165168

@@ -196,6 +199,9 @@ token Private API access token (used only when the specified platf
196199

197200
The attributes marked with a * are only required when defining the configuration of a private SCM server.
198201

202+
.. tip::
203+
A custom location for the SCM file can be specified using the ``NXF_SCM_FILE`` environment variable (requires
204+
version ``20.10.0`` or later).
199205

200206
BitBucket credentials
201207
---------------------

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: '20.07.1',
3+
VERSION: '20.10.0',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

assets/docs/latest/amazons3.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0">
99

10-
<title>Amazon S3 storage &mdash; Nextflow 20.07.1 documentation</title>
10+
<title>Amazon S3 storage &mdash; Nextflow 20.10.0 documentation</title>
1111

1212

1313

@@ -116,7 +116,6 @@
116116
<li class="toctree-l1"><a class="reference internal" href="sharing.html">Pipeline sharing</a></li>
117117
<li class="toctree-l1"><a class="reference internal" href="metadata.html">Workflow introspection</a></li>
118118
<li class="toctree-l1"><a class="reference internal" href="mail.html">Mail &amp; Notifications</a></li>
119-
<li class="toctree-l1"><a class="reference internal" href="example.html">Examples</a></li>
120119
</ul>
121120

122121

assets/docs/latest/awscloud.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0">
99

10-
<title>Amazon Cloud &mdash; Nextflow 20.07.1 documentation</title>
10+
<title>Amazon Cloud &mdash; Nextflow 20.10.0 documentation</title>
1111

1212

1313

@@ -122,7 +122,6 @@
122122
<li class="toctree-l1"><a class="reference internal" href="sharing.html">Pipeline sharing</a></li>
123123
<li class="toctree-l1"><a class="reference internal" href="metadata.html">Workflow introspection</a></li>
124124
<li class="toctree-l1"><a class="reference internal" href="mail.html">Mail &amp; Notifications</a></li>
125-
<li class="toctree-l1"><a class="reference internal" href="example.html">Examples</a></li>
126125
</ul>
127126

128127

assets/docs/latest/basic.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
<meta name="viewport" content="width=device-width, initial-scale=1.0">
99

10-
<title>Basic concepts &mdash; Nextflow 20.07.1 documentation</title>
10+
<title>Basic concepts &mdash; Nextflow 20.10.0 documentation</title>
1111

1212

1313

@@ -113,7 +113,6 @@
113113
<li class="toctree-l1"><a class="reference internal" href="sharing.html">Pipeline sharing</a></li>
114114
<li class="toctree-l1"><a class="reference internal" href="metadata.html">Workflow introspection</a></li>
115115
<li class="toctree-l1"><a class="reference internal" href="mail.html">Mail &amp; Notifications</a></li>
116-
<li class="toctree-l1"><a class="reference internal" href="example.html">Examples</a></li>
117116
</ul>
118117

119118

0 commit comments

Comments
 (0)