Skip to content

Commit bf61245

Browse files
committed
Update edge docs to 20.08.0-edge
1 parent 931c86b commit bf61245

40 files changed

+474
-97
lines changed

assets/docs/edge/.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: e728c08ca6f64c043191430e4f2e3739
3+
config: 0a7bb7bf0a57468e68f6cd8b44a6b665
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

assets/docs/edge/_sources/channel.rst.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ pair and the second element is the list of files (sorted in lexicographical orde
340340

341341
Channel
342342
.fromFilePairs('/my/data/SRR*_{1,2}.fastq')
343-
.println()
343+
.view()
344344

345345
It will produce an output similar to the following::
346346

@@ -361,7 +361,7 @@ For example::
361361

362362
Channel
363363
.fromFilePairs('/some/data/*', size: -1) { file -> file.extension }
364-
.println { ext, files -> "Files with the extension $ext are $files" }
364+
.view { ext, files -> "Files with the extension $ext are $files" }
365365

366366

367367
Table of optional parameters available:
@@ -395,7 +395,7 @@ the FASTQ files matching the specified criteria i.e project or accession number(
395395

396396
Channel
397397
.fromSRA('SRP043510')
398-
.println()
398+
.view()
399399

400400

401401
It returns::
@@ -413,7 +413,7 @@ Multiple accession IDs can be specified using a list object::
413413
ids = ['ERR908507', 'ERR908506', 'ERR908505']
414414
Channel
415415
.fromSRA(ids)
416-
.println()
416+
.view()
417417

418418
::
419419

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -810,6 +810,7 @@ NXF_OFFLINE When ``true`` disables the project automatic downloa
810810
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``.
811811
NXF_ANSI_LOG Enables/disables ANSI console output (default ``true`` when ANSI terminal is detected).
812812
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).
813814
JAVA_HOME Defines the path location of the Java VM installation used to run Nextflow.
814815
JAVA_CMD Defines the path location of the Java binary command used to launch Nextflow.
815816
HTTP_PROXY Defines the HTTP proxy server

assets/docs/edge/_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 14) <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/edge/_sources/process.rst.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -934,7 +934,7 @@ this is a value which has been defined in the `input` declaration block, as show
934934

935935
}
936936

937-
receiver.println { "Received: $it" }
937+
receiver.view { "Received: $it" }
938938

939939

940940
Valid output values are value literals, input values identifiers, variables accessible in the process scope and

assets/docs/edge/_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/edge/_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.08.0-SNAPSHOT',
3+
VERSION: '20.08.0-edge',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',

assets/docs/edge/amazons3.html

Lines changed: 14 additions & 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.08.0-SNAPSHOT documentation</title>
10+
<title>Amazon S3 storage &mdash; Nextflow 20.08.0-edge documentation</title>
1111

1212

1313

@@ -272,7 +272,7 @@ <h2>Advanced configuration<a class="headerlink" href="#advanced-configuration" t
272272
<div role="contentinfo">
273273
<p>
274274

275-
&copy; Copyright 2013-2019, Centre for Genomic Regulation (CRG). 2020, Seqera Labs.
275+
&copy; Copyright 2020, Seqera Labs. 2013-2019, Centre for Genomic Regulation (CRG).
276276

277277
</p>
278278
</div>
@@ -304,6 +304,18 @@ <h2>Advanced configuration<a class="headerlink" href="#advanced-configuration" t
304304

305305

306306

307+
<!-- Theme Analytics -->
308+
<script>
309+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
310+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
311+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
312+
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
313+
314+
ga('create', 'UA-364526-10', 'auto');
315+
ga('send', 'pageview');
316+
</script>
317+
318+
307319

308320

309321
</body>

assets/docs/edge/awscloud.html

Lines changed: 14 additions & 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.08.0-SNAPSHOT documentation</title>
10+
<title>Amazon Cloud &mdash; Nextflow 20.08.0-edge documentation</title>
1111

1212

1313

@@ -491,7 +491,7 @@ <h2>Advanced configuration<a class="headerlink" href="#advanced-configuration" t
491491
<div role="contentinfo">
492492
<p>
493493

494-
&copy; Copyright 2013-2019, Centre for Genomic Regulation (CRG). 2020, Seqera Labs.
494+
&copy; Copyright 2020, Seqera Labs. 2013-2019, Centre for Genomic Regulation (CRG).
495495

496496
</p>
497497
</div>
@@ -523,6 +523,18 @@ <h2>Advanced configuration<a class="headerlink" href="#advanced-configuration" t
523523

524524

525525

526+
<!-- Theme Analytics -->
527+
<script>
528+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
529+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
530+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
531+
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
532+
533+
ga('create', 'UA-364526-10', 'auto');
534+
ga('send', 'pageview');
535+
</script>
536+
537+
526538

527539

528540
</body>

assets/docs/edge/basic.html

Lines changed: 14 additions & 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.08.0-SNAPSHOT documentation</title>
10+
<title>Basic concepts &mdash; Nextflow 20.08.0-edge documentation</title>
1111

1212

1313

@@ -310,7 +310,7 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
310310
<div role="contentinfo">
311311
<p>
312312

313-
&copy; Copyright 2013-2019, Centre for Genomic Regulation (CRG). 2020, Seqera Labs.
313+
&copy; Copyright 2020, Seqera Labs. 2013-2019, Centre for Genomic Regulation (CRG).
314314

315315
</p>
316316
</div>
@@ -342,6 +342,18 @@ <h2>Configuration options<a class="headerlink" href="#configuration-options" tit
342342

343343

344344

345+
<!-- Theme Analytics -->
346+
<script>
347+
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
348+
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
349+
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
350+
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
351+
352+
ga('create', 'UA-364526-10', 'auto');
353+
ga('send', 'pageview');
354+
</script>
355+
356+
345357

346358

347359
</body>

0 commit comments

Comments
 (0)