Skip to content

Commit

Permalink
[ci skip] Autodoc commit for 6e43cfa.
Browse files Browse the repository at this point in the history
  • Loading branch information
oscwiag committed Dec 12, 2023
1 parent a1ffbd7 commit 25ca4b7
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 1 deletion.
21 changes: 21 additions & 0 deletions develop/_sources/reference/files/ondemand-d-ymls.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,27 @@ Configuration Properties with profile support
custom_css_files: ["/myfolder/navigation.css", "/myfolder/pinned_apps.css"]
.. describe:: custom_javascript_files (Array<String>, [])

List of relative URLs to custom javascript files to include in all Dashboard pages.
These javascript files can be used to customize the behavior of the Dashboard.

The relative path will be prefixed with the value of the ``public_url`` property.

Default
Empty list, no custom javascript files will be included.

.. code-block:: yaml
custom_javascript_files: []
Example
Add two custom Javascript files: ``/myfolder/navigation.js`` and ``/myfolder/pinned_apps.js`` to the Dashboard.

.. code-block:: yaml
custom_javascript_files: ["/myfolder/navigation.js", "/myfolder/pinned_apps.js"]
.. describe:: dashboard_title (String, 'Open OnDemand')

The text to use as the main navigation logo. If the ``dashboard_header_img_logo`` property is defined,
Expand Down
20 changes: 20 additions & 0 deletions develop/reference/files/ondemand-d-ymls.html
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,26 @@
</dl>
</dd></dl>

<dl class="describe">
<dt>
<code class="sig-name descname">custom_javascript_files (Array&lt;String&gt;, [])</code></dt>
<dd><p>List of relative URLs to custom javascript files to include in all Dashboard pages.
These javascript files can be used to customize the behavior of the Dashboard.</p>
<p>The relative path will be prefixed with the value of the <code class="docutils literal notranslate"><span class="pre">public_url</span></code> property.</p>
<dl>
<dt>Default</dt><dd><p>Empty list, no custom javascript files will be included.</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">custom_javascript_files</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[]</span><span class="w"></span>
</pre></div>
</div>
</dd>
<dt>Example</dt><dd><p>Add two custom Javascript files: <code class="docutils literal notranslate"><span class="pre">/myfolder/navigation.js</span></code> and <code class="docutils literal notranslate"><span class="pre">/myfolder/pinned_apps.js</span></code> to the Dashboard.</p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">custom_javascript_files</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="s">&quot;/myfolder/navigation.js&quot;</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="s">&quot;/myfolder/pinned_apps.js&quot;</span><span class="p p-Indicator">]</span><span class="w"></span>
</pre></div>
</div>
</dd>
</dl>
</dd></dl>

<dl class="describe">
<dt>
<code class="sig-name descname">dashboard_title (String, 'Open OnDemand')</code></dt>
Expand Down
2 changes: 1 addition & 1 deletion develop/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 25ca4b7

Please sign in to comment.