Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
sistemicorp committed Apr 11, 2024
1 parent 505b9ad commit f5bd342
Show file tree
Hide file tree
Showing 13 changed files with 59 additions and 14 deletions.
Binary file modified docs/build/doctrees/_development.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/build/doctrees/prism_scripts.doctree
Binary file not shown.
18 changes: 14 additions & 4 deletions docs/build/html/_development.html
Original file line number Diff line number Diff line change
Expand Up @@ -218,11 +218,21 @@ <h2><a class="toc-backref" href="#id6">Command Line Development</a><a class="hea
</div>
<p>Notes about the command line development environment,</p>
<ul class="simple">
<li><p>parallel, multi-threaded, multiple test jigs are not supported</p></li>
<li><p>script is run as a single thread</p></li>
<li><p>NO results are sent to the Lente Server, however a local file with the results
<li><p>parallel, multi-threaded, multiple test jigs are not supported</p>
<ul>
<li><p>script is run as a single thread - cannot test parallelism</p></li>
</ul>
</li>
<li><p>Results are NOT sent to the Lente Server, however a local Result file with the results
will be created for inspection purposes.</p></li>
<li><p>script substitutions are not supported, use helper script <cite>prism_subs.py</cite></p></li>
<li><p>script substitutions are not supported, leaving two options for developers,</p>
<ul>
<li><p>rename script <cite>subs</cite> section to something else and populate the subs manually, save this
script to a new name while developing. Revert after everything is working.</p></li>
<li><p>use helper script <cite>prism_subs.py</cite>, which will perform the substitutions. This helper needs
to be modified per script it is used on.</p></li>
</ul>
</li>
</ul>
<p>After your script is running in the command line mode, you can try it in the Prism GUI.</p>
</section>
Expand Down
13 changes: 10 additions & 3 deletions docs/build/html/_sources/_development.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -199,10 +199,17 @@ The command line help,
Notes about the command line development environment,

* parallel, multi-threaded, multiple test jigs are not supported
* script is run as a single thread
* NO results are sent to the Lente Server, however a local file with the results

* script is run as a single thread - cannot test parallelism

* Results are NOT sent to the Lente Server, however a local Result file with the results
will be created for inspection purposes.
* script substitutions are not supported, use helper script `prism_subs.py`
* script substitutions are not supported, leaving two options for developers,

* rename script `subs` section to something else and populate the subs manually, save this
script to a new name while developing. Revert after everything is working.
* use helper script `prism_subs.py`, which will perform the substitutions. This helper needs
to be modified per script it is used on.

After your script is running in the command line mode, you can try it in the Prism GUI.

7 changes: 7 additions & 0 deletions docs/build/html/_sources/prism_scripts.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,13 @@ Here is a full example of what `subs` section could look like (taken from exampl
* sets the default value for `textinput` ``widget``
* optional

Inner Subs
----------

Inner subs allow one User sub to be able to set multiple other subs. An example is shown in the ``subs`` section
above. In the above example, when `Location` is selected by the user, `TST000Min` is assigned a value
depending on the `Location` selected.

info
----

Expand Down
Binary file modified docs/build/html/objects.inv
Binary file not shown.
1 change: 1 addition & 0 deletions docs/build/html/prism_main.html
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ <h1>Prism<a class="headerlink" href="#prism" title="Permalink to this headline">
</li>
<li class="toctree-l1"><a class="reference internal" href="prism_scripts.html">Scripts</a><ul>
<li class="toctree-l2"><a class="reference internal" href="prism_scripts.html#subs">subs</a></li>
<li class="toctree-l2"><a class="reference internal" href="prism_scripts.html#inner-subs">Inner Subs</a></li>
<li class="toctree-l2"><a class="reference internal" href="prism_scripts.html#info">info</a></li>
<li class="toctree-l2"><a class="reference internal" href="prism_scripts.html#config">config</a></li>
<li class="toctree-l2"><a class="reference internal" href="prism_scripts.html#tests">tests</a></li>
Expand Down
6 changes: 6 additions & 0 deletions docs/build/html/prism_scripts.html
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,12 @@ <h2>subs<a class="headerlink" href="#subs" title="Permalink to this headline">¶
<li><p>optional</p></li>
</ul>
</section>
<section id="inner-subs">
<h2>Inner Subs<a class="headerlink" href="#inner-subs" title="Permalink to this headline"></a></h2>
<p>Inner subs allow one User sub to be able to set multiple other subs. An example is shown in the <code class="docutils literal notranslate"><span class="pre">subs</span></code> section
above. In the above example, when <cite>Location</cite> is selected by the user, <cite>TST000Min</cite> is assigned a value
depending on the <cite>Location</cite> selected.</p>
</section>
<section id="info">
<h2>info<a class="headerlink" href="#info" title="Permalink to this headline"></a></h2>
<p>This section is a list of fields that correspond to fields that exist in the backend database and are typically
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js

Large diffs are not rendered by default.

13 changes: 10 additions & 3 deletions docs/source/_development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -199,10 +199,17 @@ The command line help,
Notes about the command line development environment,

* parallel, multi-threaded, multiple test jigs are not supported
* script is run as a single thread
* NO results are sent to the Lente Server, however a local file with the results

* script is run as a single thread - cannot test parallelism

* Results are NOT sent to the Lente Server, however a local Result file with the results
will be created for inspection purposes.
* script substitutions are not supported, use helper script `prism_subs.py`
* script substitutions are not supported, leaving two options for developers,

* rename script `subs` section to something else and populate the subs manually, save this
script to a new name while developing. Revert after everything is working.
* use helper script `prism_subs.py`, which will perform the substitutions. This helper needs
to be modified per script it is used on.

After your script is running in the command line mode, you can try it in the Prism GUI.

7 changes: 7 additions & 0 deletions docs/source/prism_scripts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,13 @@ Here is a full example of what `subs` section could look like (taken from exampl
* sets the default value for `textinput` ``widget``
* optional

Inner Subs
----------

Inner subs allow one User sub to be able to set multiple other subs. An example is shown in the ``subs`` section
above. In the above example, when `Location` is selected by the user, `TST000Min` is assigned a value
depending on the `Location` selected.

info
----

Expand Down
6 changes: 3 additions & 3 deletions public/VERSION
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
prev_commit=971cda8d0c226423b4b5e73d5aabb74b63284293
date=2024-04-11 10:35:52 -0400
prev_commit=505b9ad673ba8f4830f7b14a50c15ad0eec30cdb
date=2024-04-11 10:45:29 -0400
branch=master
version=0.7-7-g971cda8
version=0.7-8-g505b9ad

0 comments on commit f5bd342

Please sign in to comment.