Skip to content

Commit

Permalink
[ci skip] Autodoc commit for 0a43286f3989c9e985e29a58cb3bfc46b3c4011a.
Browse files Browse the repository at this point in the history
  • Loading branch information
oscwiag committed Oct 31, 2023
1 parent 043e41d commit c81fc75
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 7 deletions.
11 changes: 11 additions & 0 deletions latest/_sources/how-tos/app-development/interactive/form.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -213,6 +213,17 @@ auto_modules_<MODULE>
Meaning only versions appropriate to a given cluster will be shown when that
cluster is chosen.

.. note::

The form configuration is case sensitive. So there is a difference between
``auto_modules_R`` and ``auto_modules_r``.

Hyphens cause issues in templating the script files. For example,
a form configuration like ``auto_modules_netcdf-serial`` would need to be
referenced in the ``script.sh.erb`` as ``<%= auto_modules_netcdf_serial %>``
replacing any hyphens (``-``) with underscores ``_``.


auto_groups
This will automatically generate a ``select`` widget populated with a list of the Unix
groups the user is currently in. Administrators can configure :ref:`filter for autogroups <auto_groups_filter>`
Expand Down
10 changes: 7 additions & 3 deletions latest/_sources/reference/files/ondemand-d-ymls.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -591,9 +591,13 @@ Configuration Properties
.. _module_file_dir:
.. describe:: module_file_dir (String, null)

Specify a directory where module files per cluster exist. This directory
should have module spider-json output as indicated by the command below.
Open OnDemand will read these files and potentially show them in a from.
Specify a directory where **cluster specific module files** exist. It's important
that there be a file for each cluster because the system can then tie those
modules to that specific cluster.

This directory should have ``module spider-json`` output **for each cluster**
as indicated by the command below. Open OnDemand will read these files and
potentially show them in a from for a cluster called **my_cluster**.

``$LMOD_DIR/spider -o spider-json $MODULEPATH > /some/directory/my_cluster.json``

Expand Down
9 changes: 9 additions & 0 deletions latest/how-tos/app-development/interactive/form.html
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,15 @@ <h2>Attributes<a class="headerlink" href="#attributes" title="Permalink to this
<p>If you have dynamic form widgets enabled, the option list will be cluster aware.
Meaning only versions appropriate to a given cluster will be shown when that
cluster is chosen.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The form configuration is case sensitive. So there is a difference between
<code class="docutils literal notranslate"><span class="pre">auto_modules_R</span></code> and <code class="docutils literal notranslate"><span class="pre">auto_modules_r</span></code>.</p>
<p>Hyphens cause issues in templating the script files. For example,
a form configuration like <code class="docutils literal notranslate"><span class="pre">auto_modules_netcdf-serial</span></code> would need to be
referenced in the <code class="docutils literal notranslate"><span class="pre">script.sh.erb</span></code> as <code class="docutils literal notranslate"><span class="pre">&lt;%=</span> <span class="pre">auto_modules_netcdf_serial</span> <span class="pre">%&gt;</span></code>
replacing any hyphens (<code class="docutils literal notranslate"><span class="pre">-</span></code>) with underscores <code class="docutils literal notranslate"><span class="pre">_</span></code>.</p>
</div>
</dd>
<dt>auto_groups</dt><dd><p>This will automatically generate a <code class="docutils literal notranslate"><span class="pre">select</span></code> widget populated with a list of the Unix
groups the user is currently in. Administrators can configure <a class="reference internal" href="../../../reference/files/ondemand-d-ymls.html#auto-groups-filter"><span class="std std-ref">filter for autogroups</span></a>
Expand Down
9 changes: 6 additions & 3 deletions latest/reference/files/ondemand-d-ymls.html
Original file line number Diff line number Diff line change
Expand Up @@ -802,9 +802,12 @@
<span class="target" id="module-file-dir"></span><dl class="describe">
<dt>
<code class="sig-name descname">module_file_dir (String, null)</code></dt>
<dd><p>Specify a directory where module files per cluster exist. This directory
should have module spider-json output as indicated by the command below.
Open OnDemand will read these files and potentially show them in a from.</p>
<dd><p>Specify a directory where <strong>cluster specific module files</strong> exist. It’s important
that there be a file for each cluster because the system can then tie those
modules to that specific cluster.</p>
<p>This directory should have <code class="docutils literal notranslate"><span class="pre">module</span> <span class="pre">spider-json</span></code> output <strong>for each cluster</strong>
as indicated by the command below. Open OnDemand will read these files and
potentially show them in a from for a cluster called <strong>my_cluster</strong>.</p>
<p><code class="docutils literal notranslate"><span class="pre">$LMOD_DIR/spider</span> <span class="pre">-o</span> <span class="pre">spider-json</span> <span class="pre">$MODULEPATH</span> <span class="pre">&gt;</span> <span class="pre">/some/directory/my_cluster.json</span></code></p>
<dl>
<dt>Default</dt><dd><p>Null. No directory given.</p>
Expand Down
2 changes: 1 addition & 1 deletion latest/searchindex.js

Large diffs are not rendered by default.

0 comments on commit c81fc75

Please sign in to comment.