Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@barnjamin
barnjamin committed Sep 23, 2022
1 parent b7c6307 commit 73a6905
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 11 deletions.
Binary file modified docs/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/doctrees/usage.doctree
View file
Binary file not shown.
5 changes: 4 additions & 1 deletion docs/html/_modules/beaker/application.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,10 @@ <h1>Source code for beaker.application</h1><div class="highlight"><pre>

<span class="k">def</span> <span class="nf">dump</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">directory</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">&quot;.&quot;</span><span class="p">):</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">os.path</span>
<span class="kn">import</span> <span class="nn">os</span>

<span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">directory</span><span class="p">):</span>
<span class="n">os</span><span class="o">.</span><span class="n">mkdir</span><span class="p">(</span><span class="n">directory</span><span class="p">)</span>

<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">directory</span><span class="p">,</span> <span class="s2">&quot;approval.teal&quot;</span><span class="p">),</span> <span class="s2">&quot;w&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">approval_program</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
Expand Down
10 changes: 5 additions & 5 deletions docs/html/_modules/beaker/client/application_client.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ <h1>Source code for beaker.client.application_client</h1><div class="highlight">
<span class="n">atc</span><span class="p">,</span>
<span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">on_create</span><span class="p">,</span>
<span class="n">sender</span><span class="o">=</span><span class="n">sender</span><span class="p">,</span>
<span class="n">sp</span><span class="o">=</span><span class="n">sp</span><span class="p">,</span>
<span class="n">suggested_params</span><span class="o">=</span><span class="n">sp</span><span class="p">,</span>
<span class="n">on_complete</span><span class="o">=</span><span class="n">on_complete</span><span class="p">,</span>
<span class="n">approval_program</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">approval_binary</span><span class="p">,</span>
<span class="n">clear_program</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">clear_binary</span><span class="p">,</span>
Expand Down Expand Up @@ -272,7 +272,7 @@ <h1>Source code for beaker.client.application_client</h1><div class="highlight">
<span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">on_update</span><span class="p">,</span>
<span class="n">on_complete</span><span class="o">=</span><span class="n">transaction</span><span class="o">.</span><span class="n">OnComplete</span><span class="o">.</span><span class="n">UpdateApplicationOC</span><span class="p">,</span>
<span class="n">sender</span><span class="o">=</span><span class="n">sender</span><span class="p">,</span>
<span class="n">sp</span><span class="o">=</span><span class="n">sp</span><span class="p">,</span>
<span class="n">suggested_params</span><span class="o">=</span><span class="n">sp</span><span class="p">,</span>
<span class="n">index</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">app_id</span><span class="p">,</span>
<span class="n">approval_program</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">approval_binary</span><span class="p">,</span>
<span class="n">clear_program</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">clear_binary</span><span class="p">,</span>
Expand Down Expand Up @@ -326,7 +326,7 @@ <h1>Source code for beaker.client.application_client</h1><div class="highlight">
<span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">on_opt_in</span><span class="p">,</span>
<span class="n">on_complete</span><span class="o">=</span><span class="n">transaction</span><span class="o">.</span><span class="n">OnComplete</span><span class="o">.</span><span class="n">OptInOC</span><span class="p">,</span>
<span class="n">sender</span><span class="o">=</span><span class="n">sender</span><span class="p">,</span>
<span class="n">sp</span><span class="o">=</span><span class="n">sp</span><span class="p">,</span>
<span class="n">suggested_params</span><span class="o">=</span><span class="n">sp</span><span class="p">,</span>
<span class="n">index</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">app_id</span><span class="p">,</span>
<span class="n">app_args</span><span class="o">=</span><span class="n">args</span><span class="p">,</span>
<span class="n">signer</span><span class="o">=</span><span class="n">signer</span><span class="p">,</span>
Expand Down Expand Up @@ -377,7 +377,7 @@ <h1>Source code for beaker.client.application_client</h1><div class="highlight">
<span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">on_close_out</span><span class="p">,</span>
<span class="n">on_complete</span><span class="o">=</span><span class="n">transaction</span><span class="o">.</span><span class="n">OnComplete</span><span class="o">.</span><span class="n">CloseOutOC</span><span class="p">,</span>
<span class="n">sender</span><span class="o">=</span><span class="n">sender</span><span class="p">,</span>
<span class="n">sp</span><span class="o">=</span><span class="n">sp</span><span class="p">,</span>
<span class="n">suggested_params</span><span class="o">=</span><span class="n">sp</span><span class="p">,</span>
<span class="n">index</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">app_id</span><span class="p">,</span>
<span class="n">app_args</span><span class="o">=</span><span class="n">args</span><span class="p">,</span>
<span class="n">signer</span><span class="o">=</span><span class="n">signer</span><span class="p">,</span>
Expand Down Expand Up @@ -429,7 +429,7 @@ <h1>Source code for beaker.client.application_client</h1><div class="highlight">
<span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">on_clear_state</span><span class="p">,</span>
<span class="n">on_complete</span><span class="o">=</span><span class="n">transaction</span><span class="o">.</span><span class="n">OnComplete</span><span class="o">.</span><span class="n">ClearStateOC</span><span class="p">,</span>
<span class="n">sender</span><span class="o">=</span><span class="n">sender</span><span class="p">,</span>
<span class="n">sp</span><span class="o">=</span><span class="n">sp</span><span class="p">,</span>
<span class="n">suggested_params</span><span class="o">=</span><span class="n">sp</span><span class="p">,</span>
<span class="n">index</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">app_id</span><span class="p">,</span>
<span class="n">app_args</span><span class="o">=</span><span class="n">args</span><span class="p">,</span>
<span class="n">signer</span><span class="o">=</span><span class="n">signer</span><span class="p">,</span>
Expand Down
1 change: 0 additions & 1 deletion docs/html/_sources/usage.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Tutorial

.. note::
This tutorial assumes you've already installed the `sandbox <https://github.com/algorand/sandbox>`_ and have it running.
Currently Beaker requires sandbox running with ``source`` config (or any config with `this <https://github.com/algorand/go-algorand/pull/4198>`_ commit).


Lets write a simple calculator app. `Full source here <https://github.com/algorand-devrel/beaker/blob/master/examples/simple/calculator.py>`_.
Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js
View file

Large diffs are not rendered by default.

3 changes: 1 addition & 2 deletions docs/html/usage.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,7 @@ <h1>Usage<a class="headerlink" href="#usage" title="Permalink to this heading">
<span id="id1"></span><h2>Tutorial<a class="headerlink" href="#tutorial" title="Permalink to this heading"></a></h2>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>This tutorial assumes you’ve already installed the <a class="reference external" href="https://github.com/algorand/sandbox">sandbox</a> and have it running.
Currently Beaker requires sandbox running with <code class="docutils literal notranslate"><span class="pre">source</span></code> config (or any config with <a class="reference external" href="https://github.com/algorand/go-algorand/pull/4198">this</a> commit).</p>
<p>This tutorial assumes you’ve already installed the <a class="reference external" href="https://github.com/algorand/sandbox">sandbox</a> and have it running.</p>
</div>
<p>Lets write a simple calculator app. <a class="reference external" href="https://github.com/algorand-devrel/beaker/blob/master/examples/simple/calculator.py">Full source here</a>.</p>
<p>First, create a class to represent our application as a subclass of the beaker <cite>Application</cite>.</p>
Expand Down
1 change: 0 additions & 1 deletion docs/source/usage.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Tutorial

.. note::
This tutorial assumes you've already installed the `sandbox <https://github.com/algorand/sandbox>`_ and have it running.
Currently Beaker requires sandbox running with ``source`` config (or any config with `this <https://github.com/algorand/go-algorand/pull/4198>`_ commit).


Lets write a simple calculator app. `Full source here <https://github.com/algorand-devrel/beaker/blob/master/examples/simple/calculator.py>`_.
Expand Down

0 comments on commit 73a6905

Please sign in to comment.