Deploy documentation from GitHub Actions

multiversx · Apr 3, 2024 · 1492e2c · 1492e2c
1 parent e87787c
commit 1492e2c
Show file tree

Hide file tree

Showing 186 changed files with 54,811 additions and 1 deletion.
diff --git a/_modules/index.html b/_modules/index.html
diff --git a/_modules/multiversx_sdk/core/account.html b/_modules/multiversx_sdk/core/account.html
@@ -0,0 +1,134 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../../../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>multiversx_sdk.core.account &mdash; multiversx-sdk 0.9.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../../../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../../../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../../../_static/documentation_options.js?v=39bb1c6d"></script>
+        <script src="../../../_static/doctools.js?v=888ff710"></script>
+        <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../../../index.html" class="icon icon-home">
+            multiversx-sdk
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules.html">multiversx_sdk</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../../index.html">multiversx-sdk</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">multiversx_sdk.core.account</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>Source code for multiversx_sdk.core.account</h1><div class="highlight"><pre>
+<div class="viewcode-block" id="AccountNonceHolder">
+<a class="viewcode-back" href="../../../multiversx_sdk.core.html#multiversx_sdk.AccountNonceHolder">[docs]</a>
+<span></span><span class="k">class</span> <span class="nc">AccountNonceHolder</span><span class="p">():</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;An abstraction representing an account&#39;s nonce on the Network.&quot;&quot;&quot;</span>
+
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">initial_nonce</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Creates an acount nonce holder object from an initial nonce.</span>
+
+<span class="sd">        Args:</span>
+<span class="sd">            initial_nonce (int): the current nonce of the account&quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">nonce</span> <span class="o">=</span> <span class="n">initial_nonce</span>
+
+<div class="viewcode-block" id="AccountNonceHolder.get_nonce_then_increment">
+<a class="viewcode-back" href="../../../multiversx_sdk.core.html#multiversx_sdk.AccountNonceHolder.get_nonce_then_increment">[docs]</a>
+    <span class="k">def</span> <span class="nf">get_nonce_then_increment</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">int</span><span class="p">:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Returns the current nonce then increments it</span>
+
+<span class="sd">        Returns:</span>
+<span class="sd">            int: the current nonce&quot;&quot;&quot;</span>
+        <span class="n">nonce</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">nonce</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">increment_nonce</span><span class="p">()</span>
+        <span class="k">return</span> <span class="n">nonce</span></div>
+
+
+<div class="viewcode-block" id="AccountNonceHolder.increment_nonce">
+<a class="viewcode-back" href="../../../multiversx_sdk.core.html#multiversx_sdk.AccountNonceHolder.increment_nonce">[docs]</a>
+    <span class="k">def</span> <span class="nf">increment_nonce</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Increments the current nonce&quot;&quot;&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">nonce</span> <span class="o">+=</span> <span class="mi">1</span></div>
+</div>
+
+</pre></div>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, MultiversX.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>
diff --git a/_modules/multiversx_sdk/core/account_test.html b/_modules/multiversx_sdk/core/account_test.html
@@ -0,0 +1,120 @@
+<!DOCTYPE html>
+<html class="writer-html5" lang="en" data-content_root="../../../">
+<head>
+  <meta charset="utf-8" />
+  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <title>multiversx_sdk.core.account_test &mdash; multiversx-sdk 0.9.0 documentation</title>
+      <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=80d5e7a1" />
+      <link rel="stylesheet" type="text/css" href="../../../_static/css/theme.css?v=19f00094" />
+
+
+  <!--[if lt IE 9]>
+    <script src="../../../_static/js/html5shiv.min.js"></script>
+  <![endif]-->
+
+        <script src="../../../_static/jquery.js?v=5d32c60e"></script>
+        <script src="../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
+        <script src="../../../_static/documentation_options.js?v=39bb1c6d"></script>
+        <script src="../../../_static/doctools.js?v=888ff710"></script>
+        <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
+    <script src="../../../_static/js/theme.js"></script>
+    <link rel="index" title="Index" href="../../../genindex.html" />
+    <link rel="search" title="Search" href="../../../search.html" /> 
+</head>
+
+<body class="wy-body-for-nav"> 
+  <div class="wy-grid-for-nav">
+    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+      <div class="wy-side-scroll">
+        <div class="wy-side-nav-search" >
+
+
+
+          <a href="../../../index.html" class="icon icon-home">
+            multiversx-sdk
+          </a>
+<div role="search">
+  <form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get">
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
+    <input type="hidden" name="check_keywords" value="yes" />
+    <input type="hidden" name="area" value="default" />
+  </form>
+</div>
+        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
+              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../../../modules.html">multiversx_sdk</a></li>
+</ul>
+
+        </div>
+      </div>
+    </nav>
+
+    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
+          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+          <a href="../../../index.html">multiversx-sdk</a>
+      </nav>
+
+      <div class="wy-nav-content">
+        <div class="rst-content">
+          <div role="navigation" aria-label="Page navigation">
+  <ul class="wy-breadcrumbs">
+      <li><a href="../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">multiversx_sdk.core.account_test</li>
+      <li class="wy-breadcrumbs-aside">
+      </li>
+  </ul>
+  <hr/>
+</div>
+          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+           <div itemprop="articleBody">
+
+  <h1>Source code for multiversx_sdk.core.account_test</h1><div class="highlight"><pre>
+<span></span>
+<span class="kn">from</span> <span class="nn">multiversx_sdk.core.account</span> <span class="kn">import</span> <span class="n">AccountNonceHolder</span>
+
+
+<div class="viewcode-block" id="test_account_nonce_holder">
+<a class="viewcode-back" href="../../../multiversx_sdk.core.html#multiversx_sdk.core.account_test.test_account_nonce_holder">[docs]</a>
+<span class="k">def</span> <span class="nf">test_account_nonce_holder</span><span class="p">():</span>
+    <span class="n">account</span> <span class="o">=</span> <span class="n">AccountNonceHolder</span><span class="p">(</span><span class="mi">41</span><span class="p">)</span>
+    <span class="n">account</span><span class="o">.</span><span class="n">nonce</span> <span class="o">=</span> <span class="mi">42</span>
+    <span class="k">assert</span> <span class="n">account</span><span class="o">.</span><span class="n">get_nonce_then_increment</span><span class="p">()</span> <span class="o">==</span> <span class="mi">42</span>
+    <span class="k">assert</span> <span class="n">account</span><span class="o">.</span><span class="n">get_nonce_then_increment</span><span class="p">()</span> <span class="o">==</span> <span class="mi">43</span>
+
+    <span class="n">account</span><span class="o">.</span><span class="n">increment_nonce</span><span class="p">()</span>
+    <span class="n">account</span><span class="o">.</span><span class="n">increment_nonce</span><span class="p">()</span>
+    <span class="n">account</span><span class="o">.</span><span class="n">increment_nonce</span><span class="p">()</span>
+    <span class="k">assert</span> <span class="n">account</span><span class="o">.</span><span class="n">nonce</span> <span class="o">==</span> <span class="mi">47</span></div>
+
+</pre></div>
+
+           </div>
+          </div>
+          <footer>
+
+  <hr/>
+
+  <div role="contentinfo">
+    <p>&#169; Copyright 2024, MultiversX.</p>
+  </div>
+
+  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
+    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
+    provided by <a href="https://readthedocs.org">Read the Docs</a>.
+
+
+</footer>
+        </div>
+      </div>
+    </section>
+  </div>
+  <script>
+      jQuery(function () {
+          SphinxRtdTheme.Navigation.enable(true);
+      });
+  </script> 
+
+</body>
+</html>