Skip to content

Commit

Permalink
[ci skip] Autodoc commit for 7f028eb.
Browse files Browse the repository at this point in the history
  • Loading branch information
oscwiag committed Nov 25, 2024
1 parent 24ddff8 commit 2471015
Show file tree
Hide file tree
Showing 6 changed files with 44 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,14 @@ This is the full list of items with details, you may supply to this yaml file to

whether or not the application is cacheable or not. Defaults to true.

.. _bc_form_header:
.. describe:: form_header (String)

New in 4.0.

Add a text header to the form. Note this is different from the
manifest's description as it does not appear as hoverover text.

.. _bc_form_attributes:

Attributes
Expand Down
16 changes: 14 additions & 2 deletions develop/_sources/release-notes/v4.0-release-notes.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,9 @@ New Features
- `noVNC quality and compression defaults`_
- `Batch connect sessions poll delay`_
- `System Status application`_
- `User mapping now accepts UIDs`
- `Remove runtime dependency on SCL`
- `User mapping now accepts UIDs`_
- `Interactive apps can have a text header`_
- `Remove runtime dependency on SCL`_

Thanks!
-------
Expand Down Expand Up @@ -338,6 +339,17 @@ User mapping scripts can now return a UID instead of a username.
This can be helpful for centers that have multiple domains and possible
username collisions.

Interactive apps can have a text header
.......................................

The item ``form_header`` can be added to intereactive applications
to display additional text in the form. Note this is different from
the ``manifest.yml``'s ``description`` field becuase it will not be
displayed on hoverover.

See the :ref:`form documentation for form_header <bc_form_header>`
for more details.

Remove runtime dependency on SCL
................................

Expand Down
8 changes: 8 additions & 0 deletions develop/how-tos/app-development/interactive/form.html
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,14 @@ <h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to
<dd><p>whether or not the application is cacheable or not. Defaults to true.</p>
</dd></dl>

<span class="target" id="bc-form-header"></span><dl class="describe">
<dt>
<code class="sig-name descname">form_header (String)</code></dt>
<dd><p>New in 4.0.</p>
<p>Add a text header to the form. Note this is different from the
manifest’s description as it does not appear as hoverover text.</p>
</dd></dl>

</div>
<div class="section" id="attributes">
<span id="bc-form-attributes"></span><h2>Attributes<a class="headerlink" href="#attributes" title="Permalink to this headline"></a></h2>
Expand Down
Binary file modified develop/objects.inv
Binary file not shown.
15 changes: 13 additions & 2 deletions develop/release-notes/v4.0-release-notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,7 @@
<li class="toctree-l4"><a class="reference internal" href="#batch-connect-sessions-poll-delay">Batch connect sessions poll delay</a></li>
<li class="toctree-l4"><a class="reference internal" href="#system-status-application">System Status application</a></li>
<li class="toctree-l4"><a class="reference internal" href="#user-mapping-now-accepts-uids">User mapping now accepts UIDs</a></li>
<li class="toctree-l4"><a class="reference internal" href="#interactive-apps-can-have-a-text-header">Interactive apps can have a text header</a></li>
<li class="toctree-l4"><a class="reference internal" href="#remove-runtime-dependency-on-scl">Remove runtime dependency on SCL</a></li>
</ul>
</li>
Expand Down Expand Up @@ -253,8 +254,9 @@ <h2>New Features<a class="headerlink" href="#new-features" title="Permalink to t
<li><p><a class="reference internal" href="#novnc-quality-and-compression-defaults">noVNC quality and compression defaults</a></p></li>
<li><p><a class="reference internal" href="#batch-connect-sessions-poll-delay">Batch connect sessions poll delay</a></p></li>
<li><p><a class="reference internal" href="#system-status-application">System Status application</a></p></li>
<li><p><cite>User mapping now accepts UIDs</cite></p></li>
<li><p><cite>Remove runtime dependency on SCL</cite></p></li>
<li><p><a class="reference internal" href="#user-mapping-now-accepts-uids">User mapping now accepts UIDs</a></p></li>
<li><p><a class="reference internal" href="#interactive-apps-can-have-a-text-header">Interactive apps can have a text header</a></p></li>
<li><p><a class="reference internal" href="#remove-runtime-dependency-on-scl">Remove runtime dependency on SCL</a></p></li>
</ul>
</div>
<div class="section" id="thanks">
Expand Down Expand Up @@ -538,6 +540,15 @@ <h3>User mapping now accepts UIDs<a class="headerlink" href="#user-mapping-now-a
This can be helpful for centers that have multiple domains and possible
username collisions.</p>
</div>
<div class="section" id="interactive-apps-can-have-a-text-header">
<h3>Interactive apps can have a text header<a class="headerlink" href="#interactive-apps-can-have-a-text-header" title="Permalink to this headline"></a></h3>
<p>The item <code class="docutils literal notranslate"><span class="pre">form_header</span></code> can be added to intereactive applications
to display additional text in the form. Note this is different from
the <code class="docutils literal notranslate"><span class="pre">manifest.yml</span></code>’s <code class="docutils literal notranslate"><span class="pre">description</span></code> field becuase it will not be
displayed on hoverover.</p>
<p>See the <a class="reference internal" href="../how-tos/app-development/interactive/form.html#bc-form-header"><span class="std std-ref">form documentation for form_header</span></a>
for more details.</p>
</div>
<div class="section" id="remove-runtime-dependency-on-scl">
<h3>Remove runtime dependency on SCL<a class="headerlink" href="#remove-runtime-dependency-on-scl" title="Permalink to this headline"></a></h3>
<p>OnDemand no longer requires SCL on RHEL based systems.
Expand Down
2 changes: 1 addition & 1 deletion develop/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 2471015

Please sign in to comment.