Skip to content

Commit

Permalink
Deployed 928b416 to 2.1 with MkDocs 1.6.0 and mike 2.1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
nvnieuwk committed Aug 20, 2024
1 parent 64ce88c commit da382c7
Show file tree
Hide file tree
Showing 2 changed files with 98 additions and 1 deletion.
97 changes: 97 additions & 0 deletions 2.1/configuration/configuration/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1030,6 +1030,39 @@
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>

<nav class="md-nav" aria-label="Summary">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#beforetext_1" class="md-nav__link">
<span class="md-ellipsis">
beforeText
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#aftertext_1" class="md-nav__link">
<span class="md-ellipsis">
afterText
</span>
</a>

</li>

</ul>
</nav>

</li>

</ul>
Expand Down Expand Up @@ -1290,6 +1323,39 @@
</ul>
</nav>

</li>

<li class="md-nav__item">
<a href="#summary" class="md-nav__link">
<span class="md-ellipsis">
Summary
</span>
</a>

<nav class="md-nav" aria-label="Summary">
<ul class="md-nav__list">

<li class="md-nav__item">
<a href="#beforetext_1" class="md-nav__link">
<span class="md-ellipsis">
beforeText
</span>
</a>

</li>

<li class="md-nav__item">
<a href="#aftertext_1" class="md-nav__link">
<span class="md-ellipsis">
afterText
</span>
</a>

</li>

</ul>
</nav>

</li>

</ul>
Expand Down Expand Up @@ -1395,6 +1461,10 @@ <h3 id="beforetext">beforeText</h3>
<p>Any string provided to this option will printed before the help message.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="n">validation</span><span class="o">.</span><span class="na">help</span><span class="o">.</span><span class="na">beforeText</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;Running pipeline version 1.0&quot;</span><span class="w"> </span><span class="c1">// default: &quot;&quot;</span>
</code></pre></div>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>All color values (like <code>\033[0;31m</code>, which means the color red) will be filtered out when <code>validation.monochromeLogs</code> is set to <code>true</code></p>
</div>
<h3 id="command">command</h3>
<div class="admonition example">
<p class="admonition-title">This option does not affect the help message created by the <code>paramsHelp()</code> function</p>
Expand All @@ -1407,13 +1477,40 @@ <h3 id="command">command</h3>
<a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a>
<a id="__codelineno-16-3" name="__codelineno-16-3" href="#__codelineno-16-3"></a><span class="w"> </span>nextflow<span class="w"> </span>run<span class="w"> </span>main.nf<span class="w"> </span>--input<span class="w"> </span>samplesheet.csv<span class="w"> </span>--outdir<span class="w"> </span>output
</code></pre></div>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>All color values (like <code>\033[0;31m</code>, which means the color red) will be filtered out when <code>validation.monochromeLogs</code> is set to <code>true</code></p>
</div>
<h3 id="aftertext">afterText</h3>
<div class="admonition example">
<p class="admonition-title">This option does not affect the help message created by the <code>paramsHelp()</code> function</p>
</div>
<p>Any string provided to this option will be printed after the help message.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="n">validation</span><span class="o">.</span><span class="na">help</span><span class="o">.</span><span class="na">afterText</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;Please cite the pipeline owners when using this pipeline&quot;</span><span class="w"> </span><span class="c1">// default: &quot;&quot;</span>
</code></pre></div>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>All color values (like <code>\033[0;31m</code>, which means the color red) will be filtered out when <code>validation.monochromeLogs</code> is set to <code>true</code></p>
</div>
<h2 id="summary">Summary</h2>
<p>The <code>validation.summary</code> config scope can be used to configure the output of the <code>paramsSummaryLog()</code> function.</p>
<p>This scope contains the following options:</p>
<h3 id="beforetext_1">beforeText</h3>
<p>Any string provided to this option will printed before the parameters log message.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="n">validation</span><span class="o">.</span><span class="na">summary</span><span class="o">.</span><span class="na">beforeText</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;Running pipeline version 1.0&quot;</span><span class="w"> </span><span class="c1">// default: &quot;&quot;</span>
</code></pre></div>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>All color values (like <code>\033[0;31m</code>, which means the color red) will be filtered out when <code>validation.monochromeLogs</code> is set to <code>true</code></p>
</div>
<h3 id="aftertext_1">afterText</h3>
<p>Any string provided to this option will be printed after the parameters log message.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="n">validation</span><span class="o">.</span><span class="na">summary</span><span class="o">.</span><span class="na">afterText</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;Please cite the pipeline owners when using this pipeline&quot;</span><span class="w"> </span><span class="c1">// default: &quot;&quot;</span>
</code></pre></div>
<div class="admonition info">
<p class="admonition-title">Info</p>
<p>All color values (like <code>\033[0;31m</code>, which means the color red) will be filtered out when <code>validation.monochromeLogs</code> is set to <code>true</code></p>
</div>



Expand Down
2 changes: 1 addition & 1 deletion 2.1/search/search_index.json

Large diffs are not rendered by default.

0 comments on commit da382c7

Please sign in to comment.