Skip to content

Commit

Permalink
[ci skip] Autodoc commit for 800e7a1864ec03f2d7372582c16f3d0d9951bdd9.
Browse files Browse the repository at this point in the history
  • Loading branch information
oscwiag committed Dec 20, 2024
1 parent 6d3c63c commit ebba709
Show file tree
Hide file tree
Showing 21 changed files with 395 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -310,3 +310,5 @@ really have any meaning in the LinuxHost Adapter.
.. _ruby string: https://ruby-doc.org/core-2.2.0/String.html
.. _markdown: https://en.wikipedia.org/wiki/Markdown


Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,4 @@ Each of these files/directories are described below in their respective stage.
interactive/conn-params
interactive/additional-info
interactive/saved-settings
interactive/advanced
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.. _app-development-interactive-advanced:

Advanced Interactive Application Configurations
===============================================

Now that you have an application up and running,
here are some advanced features you can use.

Displaying choices made in Session Card
---------------------------------------

If you want to show a form attribute in the session card, you can set the
:ref:`display <display_option>` option to ``true``. For example, to show the
version of R selected edit ``form.yml`` with:

.. code-block:: yaml
:emphasize-lines: 3
attributes:
r_version:
display: true # Displays the choice in the card
widget: "select"
options:
- "4.2"
- "4.1"
Original file line number Diff line number Diff line change
Expand Up @@ -592,6 +592,8 @@ are:
cacheable: false
.. _display_option:

.. describe:: display (Boolean, false)

whether the form item should be displayed in the session card after it was created.
Expand Down
1 change: 1 addition & 0 deletions develop/how-tos/app-development.html
Original file line number Diff line number Diff line change
Expand Up @@ -234,6 +234,7 @@
<li class="toctree-l2"><a class="reference internal" href="app-development/interactive/conn-params.html">Connection Parameters <code class="docutils literal notranslate"><span class="pre">conn_params</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="app-development/interactive/additional-info.html">Adding Additional Information to the session cards</a></li>
<li class="toctree-l2"><a class="reference internal" href="app-development/interactive/saved-settings.html">Saving interactive application settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="app-development/interactive/advanced.html">Advanced Interactive Application Configurations</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="app-development/app-sharing.html">App Sharing</a><ul>
Expand Down
4 changes: 2 additions & 2 deletions develop/how-tos/app-development/app-sharing.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="Install Other Interactive Apps" href="../../install-ihpc-apps.html" />
<link rel="prev" title="Saving interactive application settings" href="interactive/saved-settings.html" />
<link rel="prev" title="Advanced Interactive Application Configurations" href="interactive/advanced.html" />

<script async src="https://www.googletagmanager.com/gtag/js?id=UA-34776817-3"></script>
<script>
Expand Down Expand Up @@ -451,7 +451,7 @@ <h3>Example of Executable Sharing<a class="headerlink" href="#example-of-executa
<a href="../../install-ihpc-apps.html" class="btn btn-neutral float-right" title="Install Other Interactive Apps" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="interactive/saved-settings.html" class="btn btn-neutral float-left" title="Saving interactive application settings" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
<a href="interactive/advanced.html" class="btn btn-neutral float-left" title="Advanced Interactive Application Configurations" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>

</div>

Expand Down
5 changes: 5 additions & 0 deletions develop/how-tos/app-development/interactive.html
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,7 @@
<li class="toctree-l3"><a class="reference internal" href="interactive/conn-params.html">Connection Parameters <code class="docutils literal notranslate"><span class="pre">conn_params</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="interactive/additional-info.html">Adding Additional Information to the session cards</a></li>
<li class="toctree-l3"><a class="reference internal" href="interactive/saved-settings.html">Saving interactive application settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="interactive/advanced.html">Advanced Interactive Application Configurations</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="app-sharing.html">App Sharing</a></li>
Expand Down Expand Up @@ -342,6 +343,10 @@
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="interactive/advanced.html">Advanced Interactive Application Configurations</a><ul>
<li class="toctree-l2"><a class="reference internal" href="interactive/advanced.html#displaying-choices-made-in-session-card">Displaying choices made in Session Card</a></li>
</ul>
</li>
</ul>
</div>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,6 +131,7 @@
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="saved-settings.html">Saving interactive application settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="advanced.html">Advanced Interactive Application Configurations</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../app-sharing.html">App Sharing</a></li>
Expand Down
Loading

0 comments on commit ebba709

Please sign in to comment.