Skip to content

Commit

Permalink
[ci skip] Autodoc commit for fdaa4f3.
Browse files Browse the repository at this point in the history
  • Loading branch information
oscwiag committed Nov 21, 2024
1 parent 5674acc commit 1c4fa46
Show file tree
Hide file tree
Showing 6 changed files with 97 additions and 1 deletion.
40 changes: 40 additions & 0 deletions develop/_sources/reference/files/ondemand-d-ymls.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -929,3 +929,43 @@ Configuration Properties
.. code-block:: yaml
motd_render_html: true
.. _novnc_default_compression:
.. describe:: novnc_default_compression (Integer, 6)

The default compression value for noVNC batch connect
applications.

Default
The default compression of 6.

.. code-block:: yaml
novnc_default_compression: 6
Example
Increase the default compression to 9.

.. code-block:: yaml
novnc_default_compression: 9
.. _novnc_default_quality:
.. describe:: novnc_default_quality (Integer, 2)

The default quality value for noVNC batch connect
applications.

Default
The default quality of 2.

.. code-block:: yaml
novnc_default_quality: 2
Example
Increas the default quality setting to 9.

.. code-block:: yaml
novnc_default_quality: 9
9 changes: 9 additions & 0 deletions develop/_sources/release-notes/v4.0-release-notes.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ New Features
------------

- `Global Batch Connect items`_
- `noVNC quality and compression defaults`_

Thanks!
-------
Expand Down Expand Up @@ -103,3 +104,11 @@ in ondemand.d files to be used in any batch connect
application.

See :ref:`global_bc_form_items` for more details.

noVNC quality and compression defaults
......................................

Sites can now set the default compression and quality values
for noVNC batch connect applications through the two ``ondemand.d``
properties :ref:`novnc_default_compression <novnc_default_compression>`
and :ref:`novnc_default_quality <novnc_default_quality>`.
Binary file modified develop/objects.inv
Binary file not shown.
38 changes: 38 additions & 0 deletions develop/reference/files/ondemand-d-ymls.html
Original file line number Diff line number Diff line change
Expand Up @@ -1122,6 +1122,44 @@
</dl>
</dd></dl>

<span class="target" id="novnc-default-compression"></span><dl class="describe">
<dt>
<code class="sig-name descname">novnc_default_compression (Integer, 6)</code></dt>
<dd><p>The default compression value for noVNC batch connect
applications.</p>
<dl>
<dt>Default</dt><dd><p>The default compression of 6.</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">novnc_default_compression</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">6</span><span class="w"></span>
</pre></div>
</div>
</dd>
<dt>Example</dt><dd><p>Increase the default compression to 9.</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">novnc_default_compression</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">9</span><span class="w"></span>
</pre></div>
</div>
</dd>
</dl>
</dd></dl>

<span class="target" id="novnc-default-quality"></span><dl class="describe">
<dt>
<code class="sig-name descname">novnc_default_quality (Integer, 2)</code></dt>
<dd><p>The default quality value for noVNC batch connect
applications.</p>
<dl>
<dt>Default</dt><dd><p>The default quality of 2.</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">novnc_default_quality</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2</span><span class="w"></span>
</pre></div>
</div>
</dd>
<dt>Example</dt><dd><p>Increas the default quality setting to 9.</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">novnc_default_quality</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">9</span><span class="w"></span>
</pre></div>
</div>
</dd>
</dl>
</dd></dl>

</div>
</div>

Expand Down
9 changes: 9 additions & 0 deletions develop/release-notes/v4.0-release-notes.html
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,7 @@
</li>
<li class="toctree-l3"><a class="reference internal" href="#details-of-new-features">Details of new features</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#global-batch-connect-items">Global Batch Connect items</a></li>
<li class="toctree-l4"><a class="reference internal" href="#novnc-quality-and-compression-defaults">noVNC quality and compression defaults</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -241,6 +242,7 @@ <h2>Administrative changes<a class="headerlink" href="#administrative-changes" t
<h2>New Features<a class="headerlink" href="#new-features" title="Permalink to this headline"></a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="#global-batch-connect-items">Global Batch Connect items</a></p></li>
<li><p><a class="reference internal" href="#novnc-quality-and-compression-defaults">noVNC quality and compression defaults</a></p></li>
</ul>
</div>
<div class="section" id="thanks">
Expand Down Expand Up @@ -347,6 +349,13 @@ <h3>Global Batch Connect items<a class="headerlink" href="#global-batch-connect-
application.</p>
<p>See <a class="reference internal" href="../how-tos/app-development/interactive/form.html#global-bc-form-items"><span class="std std-ref">Global Batch Connect Form Items</span></a> for more details.</p>
</div>
<div class="section" id="novnc-quality-and-compression-defaults">
<h3>noVNC quality and compression defaults<a class="headerlink" href="#novnc-quality-and-compression-defaults" title="Permalink to this headline"></a></h3>
<p>Sites can now set the default compression and quality values
for noVNC batch connect applications through the two <code class="docutils literal notranslate"><span class="pre">ondemand.d</span></code>
properties <a class="reference internal" href="../reference/files/ondemand-d-ymls.html#novnc-default-compression"><span class="std std-ref">novnc_default_compression</span></a>
and <a class="reference internal" href="../reference/files/ondemand-d-ymls.html#novnc-default-quality"><span class="std std-ref">novnc_default_quality</span></a>.</p>
</div>
</div>
</div>

Expand Down
2 changes: 1 addition & 1 deletion develop/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 1c4fa46

Please sign in to comment.