Skip to content

Commit

Permalink
[ci skip] Autodoc commit for 5b7451a.
Browse files Browse the repository at this point in the history
  • Loading branch information
oscwiag committed Jul 11, 2024
1 parent 10ce024 commit f9fafbc
Show file tree
Hide file tree
Showing 22 changed files with 74 additions and 27 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,30 @@ Here we have a checkbox ``enable_cuda_version`` that will show
data:
hide-cuda-version-when-unchecked: true
Dynamic Element Labels
**********************

The ``data-label-*`` directive allows you to change the label of another
form element based on the selected option in a select widget.

.. code-block:: yaml
attributes:
node_type:
widget: select
options:
- [ 'small', 'small', data-label-cores: 'Number of Cores (1-4)' ]
- [ 'medium', 'medium', data-label-cores: 'Number of Cores (1-8)' ]
- [ 'large', 'large', data-label-cores: 'Number of Cores (1-16)' ]
cores:
widget: "number_field"
required: true
value: 1
In this case, selecting Node Type 'small' will change the label of Cores to
'Number of Cores (1-4)'.

Dynamic Min and Maxes
*********************

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _advanced-resource-manager-configs:

Advanced Resource Manager Configrations
=======================================
Advanced Resource Manager Configurations
========================================

This page details advanced settings for any resource manager
that could be helpful in using Open OnDemand.
Expand Down
1 change: 1 addition & 0 deletions develop/how-tos/app-development/interactive.html
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,7 @@
<li class="toctree-l2"><a class="reference internal" href="interactive/dynamic-form-widgets.html#your-own-form-js">Your own <code class="docutils literal notranslate"><span class="pre">form.js</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="interactive/dynamic-form-widgets.html#hiding-select-options">Hiding select options</a></li>
<li class="toctree-l2"><a class="reference internal" href="interactive/dynamic-form-widgets.html#hiding-entire-elements">Hiding entire elements</a></li>
<li class="toctree-l2"><a class="reference internal" href="interactive/dynamic-form-widgets.html#dynamic-element-labels">Dynamic Element Labels</a></li>
<li class="toctree-l2"><a class="reference internal" href="interactive/dynamic-form-widgets.html#dynamic-min-and-maxes">Dynamic Min and Maxes</a></li>
<li class="toctree-l2"><a class="reference internal" href="interactive/dynamic-form-widgets.html#setting-values-based-on-other-elements">Setting values based on other elements</a></li>
</ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@
<li class="toctree-l4"><a class="reference internal" href="#your-own-form-js">Your own <code class="docutils literal notranslate"><span class="pre">form.js</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#hiding-select-options">Hiding select options</a></li>
<li class="toctree-l4"><a class="reference internal" href="#hiding-entire-elements">Hiding entire elements</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dynamic-element-labels">Dynamic Element Labels</a></li>
<li class="toctree-l4"><a class="reference internal" href="#dynamic-min-and-maxes">Dynamic Min and Maxes</a></li>
<li class="toctree-l4"><a class="reference internal" href="#setting-values-based-on-other-elements">Setting values based on other elements</a></li>
</ul>
Expand Down Expand Up @@ -316,6 +317,27 @@ <h2>Hiding entire elements<a class="headerlink" href="#hiding-entire-elements" t
</span></pre></div>
</div>
</div>
<div class="section" id="dynamic-element-labels">
<h2>Dynamic Element Labels<a class="headerlink" href="#dynamic-element-labels" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">data-label-*</span></code> directive allows you to change the label of another
form element based on the selected option in a select widget.</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">attributes</span><span class="p">:</span><span class="w"></span>
<span class="w"> </span><span class="nt">node_type</span><span class="p">:</span><span class="w"></span>
<span class="w"> </span><span class="nt">widget</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">select</span><span class="w"></span>
<span class="w"> </span><span class="nt">options</span><span class="p">:</span><span class="w"></span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="w"> </span><span class="s">&#39;small&#39;</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">&#39;small&#39;</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">data-label-cores</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="s">&#39;Number</span><span class="nv"> </span><span class="s">of</span><span class="nv"> </span><span class="s">Cores</span><span class="nv"> </span><span class="s">(1-4)&#39;</span><span class="w"> </span><span class="p p-Indicator">]</span><span class="w"></span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="w"> </span><span class="s">&#39;medium&#39;</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">&#39;medium&#39;</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">data-label-cores</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="s">&#39;Number</span><span class="nv"> </span><span class="s">of</span><span class="nv"> </span><span class="s">Cores</span><span class="nv"> </span><span class="s">(1-8)&#39;</span><span class="w"> </span><span class="p p-Indicator">]</span><span class="w"></span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="w"> </span><span class="s">&#39;large&#39;</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">&#39;large&#39;</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">data-label-cores</span><span class="p p-Indicator">:</span><span class="w"> </span><span class="s">&#39;Number</span><span class="nv"> </span><span class="s">of</span><span class="nv"> </span><span class="s">Cores</span><span class="nv"> </span><span class="s">(1-16)&#39;</span><span class="w"> </span><span class="p p-Indicator">]</span><span class="w"></span>

<span class="w"> </span><span class="nt">cores</span><span class="p">:</span><span class="w"></span>
<span class="w"> </span><span class="nt">widget</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;number_field&quot;</span><span class="w"></span>
<span class="w"> </span><span class="nt">required</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w"></span>
<span class="w"> </span><span class="nt">value</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">1</span><span class="w"></span>
</pre></div>
</div>
<p>In this case, selecting Node Type ‘small’ will change the label of Cores to
‘Number of Cores (1-4)’.</p>
</div>
<div class="section" id="dynamic-min-and-maxes">
<h2>Dynamic Min and Maxes<a class="headerlink" href="#dynamic-min-and-maxes" title="Permalink to this headline"></a></h2>
<p>The <code class="docutils literal notranslate"><span class="pre">data-min</span></code> and <code class="docutils literal notranslate"><span class="pre">data-max</span></code> directives allow you to set the minimum and
Expand Down
4 changes: 2 additions & 2 deletions develop/how-tos/app-development/interactive/setup.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="next" title="1. Software Requirements" href="setup/software-requirements.html" />
<link rel="prev" title="Advanced Resource Manager Configrations" href="../../../installation/resource-manager/advanced-configs.html" />
<link rel="prev" title="Advanced Resource Manager Configurations" href="../../../installation/resource-manager/advanced-configs.html" />

<script async src="https://www.googletagmanager.com/gtag/js?id=UA-34776817-3"></script>
<script>
Expand Down Expand Up @@ -236,7 +236,7 @@
<a href="setup/software-requirements.html" class="btn btn-neutral float-right" title="1. Software Requirements" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="../../../installation/resource-manager/advanced-configs.html" class="btn btn-neutral float-left" title="Advanced Resource Manager Configrations" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="../../../installation/resource-manager/advanced-configs.html" class="btn btn-neutral float-left" title="Advanced Resource Manager Configurations" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>

Expand Down
2 changes: 1 addition & 1 deletion develop/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ <h2>Special Thanks<a class="headerlink" href="#special-thanks" title="Permalink
<li class="toctree-l2"><a class="reference internal" href="installation/resource-manager/systemd.html">Systemd</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/resource-manager/bin-override-example.html">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/resource-manager/test.html">Test Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/resource-manager/advanced-configs.html">Advanced Resource Manager Configrations</a></li>
<li class="toctree-l2"><a class="reference internal" href="installation/resource-manager/advanced-configs.html">Advanced Resource Manager Configurations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="how-tos/app-development/interactive/setup.html">Setup Interactive Apps</a><ul>
Expand Down
4 changes: 2 additions & 2 deletions develop/installation/add-cluster-config.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
<li class="toctree-l2"><a class="reference internal" href="resource-manager/systemd.html">Systemd</a></li>
<li class="toctree-l2"><a class="reference internal" href="resource-manager/bin-override-example.html">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="resource-manager/test.html">Test Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="resource-manager/advanced-configs.html">Advanced Resource Manager Configrations</a></li>
<li class="toctree-l2"><a class="reference internal" href="resource-manager/advanced-configs.html">Advanced Resource Manager Configurations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../how-tos/app-development/interactive/setup.html">Setup Interactive Apps</a></li>
Expand Down Expand Up @@ -281,7 +281,7 @@
<li class="toctree-l1"><a class="reference internal" href="resource-manager/systemd.html">Systemd</a></li>
<li class="toctree-l1"><a class="reference internal" href="resource-manager/bin-override-example.html">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="resource-manager/test.html">Test Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="resource-manager/advanced-configs.html">Advanced Resource Manager Configrations</a></li>
<li class="toctree-l1"><a class="reference internal" href="resource-manager/advanced-configs.html">Advanced Resource Manager Configurations</a></li>
</ul>
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion develop/installation/cluster-config-schema.html
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@
<li class="toctree-l2"><a class="reference internal" href="resource-manager/systemd.html">Systemd</a></li>
<li class="toctree-l2"><a class="reference internal" href="resource-manager/bin-override-example.html">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="resource-manager/test.html">Test Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="resource-manager/advanced-configs.html">Advanced Resource Manager Configrations</a></li>
<li class="toctree-l2"><a class="reference internal" href="resource-manager/advanced-configs.html">Advanced Resource Manager Configurations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../how-tos/app-development/interactive/setup.html">Setup Interactive Apps</a></li>
Expand Down
10 changes: 5 additions & 5 deletions develop/installation/resource-manager/advanced-configs.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

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

<title>Advanced Resource Manager Configrations &mdash; Open OnDemand 3.1.0 documentation</title>
<title>Advanced Resource Manager Configurations &mdash; Open OnDemand 3.1.0 documentation</title>



Expand Down Expand Up @@ -118,7 +118,7 @@
<li class="toctree-l2"><a class="reference internal" href="systemd.html">Systemd</a></li>
<li class="toctree-l2"><a class="reference internal" href="bin-override-example.html">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="test.html">Test Configuration</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Advanced Resource Manager Configrations</a><ul>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Advanced Resource Manager Configurations</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#visualization-nodes">Visualization Nodes</a></li>
</ul>
</li>
Expand Down Expand Up @@ -195,7 +195,7 @@

<li><a href="../add-cluster-config.html">Cluster Configuration</a> &raquo;</li>

<li>Advanced Resource Manager Configrations</li>
<li>Advanced Resource Manager Configurations</li>


<li class="wy-breadcrumbs-aside">
Expand All @@ -216,8 +216,8 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<div class="section" id="advanced-resource-manager-configrations">
<span id="advanced-resource-manager-configs"></span><h1>Advanced Resource Manager Configrations<a class="headerlink" href="#advanced-resource-manager-configrations" title="Permalink to this headline"></a></h1>
<div class="section" id="advanced-resource-manager-configurations">
<span id="advanced-resource-manager-configs"></span><h1>Advanced Resource Manager Configurations<a class="headerlink" href="#advanced-resource-manager-configurations" title="Permalink to this headline"></a></h1>
<p>This page details advanced settings for any resource manager
that could be helpful in using Open OnDemand.</p>
<div class="section" id="visualization-nodes">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
<li class="toctree-l2"><a class="reference internal" href="systemd.html">Systemd</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="test.html">Test Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-configs.html">Advanced Resource Manager Configrations</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-configs.html">Advanced Resource Manager Configurations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../how-tos/app-development/interactive/setup.html">Setup Interactive Apps</a></li>
Expand Down
2 changes: 1 addition & 1 deletion develop/installation/resource-manager/ccq.html
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
<li class="toctree-l2"><a class="reference internal" href="systemd.html">Systemd</a></li>
<li class="toctree-l2"><a class="reference internal" href="bin-override-example.html">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="test.html">Test Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-configs.html">Advanced Resource Manager Configrations</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-configs.html">Advanced Resource Manager Configurations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../how-tos/app-development/interactive/setup.html">Setup Interactive Apps</a></li>
Expand Down
2 changes: 1 addition & 1 deletion develop/installation/resource-manager/kubernetes.html
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@
<li class="toctree-l2"><a class="reference internal" href="systemd.html">Systemd</a></li>
<li class="toctree-l2"><a class="reference internal" href="bin-override-example.html">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="test.html">Test Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-configs.html">Advanced Resource Manager Configrations</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-configs.html">Advanced Resource Manager Configurations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../how-tos/app-development/interactive/setup.html">Setup Interactive Apps</a></li>
Expand Down
2 changes: 1 addition & 1 deletion develop/installation/resource-manager/linuxhost.html
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
<li class="toctree-l2"><a class="reference internal" href="systemd.html">Systemd</a></li>
<li class="toctree-l2"><a class="reference internal" href="bin-override-example.html">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="test.html">Test Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-configs.html">Advanced Resource Manager Configrations</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-configs.html">Advanced Resource Manager Configurations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../how-tos/app-development/interactive/setup.html">Setup Interactive Apps</a></li>
Expand Down
2 changes: 1 addition & 1 deletion develop/installation/resource-manager/lsf.html
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
<li class="toctree-l2"><a class="reference internal" href="systemd.html">Systemd</a></li>
<li class="toctree-l2"><a class="reference internal" href="bin-override-example.html">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="test.html">Test Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-configs.html">Advanced Resource Manager Configrations</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-configs.html">Advanced Resource Manager Configurations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../how-tos/app-development/interactive/setup.html">Setup Interactive Apps</a></li>
Expand Down
2 changes: 1 addition & 1 deletion develop/installation/resource-manager/pbspro.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
<li class="toctree-l2"><a class="reference internal" href="systemd.html">Systemd</a></li>
<li class="toctree-l2"><a class="reference internal" href="bin-override-example.html">A Working Example of a <code class="docutils literal notranslate"><span class="pre">bin_overrides</span></code> Script</a></li>
<li class="toctree-l2"><a class="reference internal" href="test.html">Test Configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-configs.html">Advanced Resource Manager Configrations</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-configs.html">Advanced Resource Manager Configurations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../how-tos/app-development/interactive/setup.html">Setup Interactive Apps</a></li>
Expand Down
Loading

0 comments on commit f9fafbc

Please sign in to comment.