Skip to content

Commit

Permalink
Github Actions doc build after commit 4300dac
Browse files Browse the repository at this point in the history
  • Loading branch information
bashtage committed Sep 19, 2023
1 parent 5a3a957 commit 1f89bc9
Show file tree
Hide file tree
Showing 232 changed files with 2,040 additions and 2,022 deletions.
18 changes: 18 additions & 0 deletions =61
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Requirement already satisfied: pip in /opt/hostedtoolcache/Python/3.11.5/x64/lib/python3.11/site-packages (23.2.1)
Collecting wheel
Obtaining dependency information for wheel from https://files.pythonhosted.org/packages/b8/8b/31273bf66016be6ad22bb7345c37ff350276cfd46e389a0c2ac5da9d9073/wheel-0.41.2-py3-none-any.whl.metadata
Downloading wheel-0.41.2-py3-none-any.whl.metadata (2.2 kB)
Requirement already satisfied: setuptools in /opt/hostedtoolcache/Python/3.11.5/x64/lib/python3.11/site-packages (65.5.0)
Collecting setuptools
Obtaining dependency information for setuptools from https://files.pythonhosted.org/packages/bb/26/7945080113158354380a12ce26873dd6c1ebd88d47f5bc24e2c5bb38c16a/setuptools-68.2.2-py3-none-any.whl.metadata
Downloading setuptools-68.2.2-py3-none-any.whl.metadata (6.3 kB)
Downloading wheel-0.41.2-py3-none-any.whl (64 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 64.8/64.8 kB 3.8 MB/s eta 0:00:00
Downloading setuptools-68.2.2-py3-none-any.whl (807 kB)
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 807.9/807.9 kB 9.2 MB/s eta 0:00:00
Installing collected packages: wheel, setuptools
Attempting uninstall: setuptools
Found existing installation: setuptools 65.5.0
Uninstalling setuptools-65.5.0:
Successfully uninstalled setuptools-65.5.0
Successfully installed setuptools-68.2.2 wheel-0.41.2
12 changes: 6 additions & 6 deletions devel/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@



<title>Overview: module code - RandomGen v1.23.2 (+8)</title>
<title>Overview: module code - RandomGen v1.23.2 (+14)</title>



Expand Down Expand Up @@ -75,7 +75,7 @@

<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../index.html" title="RandomGen v1.23.2 (+8)" class="md-header__button md-logo" aria-label="RandomGen v1.23.2 (+8)" data-md-component="logo">
<a href="../index.html" title="RandomGen v1.23.2 (+14)" class="md-header__button md-logo" aria-label="RandomGen v1.23.2 (+14)" data-md-component="logo">
<img src="../_static/casino.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
Expand All @@ -85,7 +85,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
RandomGen v1.23.2 (+8)
RandomGen v1.23.2 (+14)
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
Expand Down Expand Up @@ -172,10 +172,10 @@

<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../index.html" title="RandomGen v1.23.2 (+8)" class="md-nav__button md-logo" aria-label="RandomGen v1.23.2 (+8)" data-md-component="logo">
<a href="../index.html" title="RandomGen v1.23.2 (+14)" class="md-nav__button md-logo" aria-label="RandomGen v1.23.2 (+14)" data-md-component="logo">
<img src="../_static/casino.svg" alt="logo">
</a>
RandomGen v1.23.2 (+8)
RandomGen v1.23.2 (+14)
</label>

<div class="md-nav__source">
Expand Down Expand Up @@ -555,7 +555,7 @@ <h1>All modules for which code is available</h1>

Created using
<a href="https://www.sphinx-doc.org/" target="_blank" rel="noopener">Sphinx</a>
7.1.2.
7.2.6.
and
<a href="https://github.com/jbms/sphinx-immaterial/" target="_blank" rel="noopener">Sphinx-Immaterial</a>

Expand Down
28 changes: 14 additions & 14 deletions devel/bit_generators/aesctr.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@



<title>AES Counter-based RNG - RandomGen v1.23.2 (+8)</title>
<title>AES Counter-based RNG - RandomGen v1.23.2 (+14)</title>



Expand Down Expand Up @@ -80,7 +80,7 @@

<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../index.html" title="RandomGen v1.23.2 (+8)" class="md-header__button md-logo" aria-label="RandomGen v1.23.2 (+8)" data-md-component="logo">
<a href="../index.html" title="RandomGen v1.23.2 (+14)" class="md-header__button md-logo" aria-label="RandomGen v1.23.2 (+14)" data-md-component="logo">
<img src="../_static/casino.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
Expand All @@ -90,7 +90,7 @@
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
RandomGen v1.23.2 (+8)
RandomGen v1.23.2 (+14)
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
Expand Down Expand Up @@ -177,10 +177,10 @@

<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../index.html" title="RandomGen v1.23.2 (+8)" class="md-nav__button md-logo" aria-label="RandomGen v1.23.2 (+8)" data-md-component="logo">
<a href="../index.html" title="RandomGen v1.23.2 (+14)" class="md-nav__button md-logo" aria-label="RandomGen v1.23.2 (+14)" data-md-component="logo">
<img src="../_static/casino.svg" alt="logo">
</a>
RandomGen v1.23.2 (+8)
RandomGen v1.23.2 (+14)
</label>

<div class="md-nav__source">
Expand Down Expand Up @@ -1607,10 +1607,10 @@



<h1 id="module-randomgen.aes"><span id="aes-counter-based-rng"></span>AES Counter-based RNG<a class="headerlink" href="#module-randomgen.aes" title="Permalink to this heading"></a></h1>
<h1 id="module-randomgen.aes"><span id="aes-counter-based-rng"></span>AES Counter-based RNG<a class="headerlink" href="#module-randomgen.aes" title="Link to this heading"></a></h1>
<dl class="py class objdesc">
<dt class="sig sig-object highlight sig-wrap py" id="randomgen.aes.AESCounter">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">randomgen.aes.</span></span><span class="sig-name descname"><span class="pre">AESCounter</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#randomgen.aes.AESCounter.__init__.seed" title="randomgen.aes.AESCounter.__init__.seed (Python parameter) — Random seed initializing the pseudo-random number generator. Can be an integer in [0, 2**128), a SeedSequence instance or None (the default). If seed is None, then data is read from /dev/urandom (or the Windows analog) if available. If unavailable, a hash of the time and process ID is used."><span class="n"><span class="pre">seed</span></span></a><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#randomgen.aes.AESCounter.__init__.counter" title="randomgen.aes.AESCounter.__init__.counter (Python parameter) — Counter to use in the AESCounter state. Can be either a Python int in [0, 2**128) or a 2-element uint64 array. If not provided, the counter is initialized at 0."><span class="n"><span class="pre">counter</span></span></a><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#randomgen.aes.AESCounter.__init__.key" title="randomgen.aes.AESCounter.__init__.key (Python parameter) — Key to use in the AESCounter state. Unlike seed, which is run through another RNG before use, the value in key is directly set. Can be either a Python int in [0, 2**128) or a 2-element uint64 array. key and seed cannot both be used."><span class="n"><span class="pre">key</span></span></a><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#randomgen.aes.AESCounter.__init__.mode" title="randomgen.aes.AESCounter.__init__.mode (Python parameter) — The seeding mode to use. &quot;legacy&quot; uses the legacy SplitMix64-based initialization. &quot;sequence&quot; uses a SeedSequence to transforms the seed into an initial state. None defaults to &quot;sequence&quot;."><span class="n"><span class="pre">mode</span></span></a><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span><a class="headerlink" href="#randomgen.aes.AESCounter" title="Permalink to this definition"></a></dt>
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">randomgen.aes.</span></span><span class="sig-name descname"><span class="pre">AESCounter</span></span><span class="sig-paren">(</span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#randomgen.aes.AESCounter.__init__.seed" title="randomgen.aes.AESCounter.__init__.seed (Python parameter) — Random seed initializing the pseudo-random number generator. Can be an integer in [0, 2**128), a SeedSequence instance or None (the default). If seed is None, then data is read from /dev/urandom (or the Windows analog) if available. If unavailable, a hash of the time and process ID is used."><span class="n"><span class="pre">seed</span></span></a><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#randomgen.aes.AESCounter.__init__.counter" title="randomgen.aes.AESCounter.__init__.counter (Python parameter) — Counter to use in the AESCounter state. Can be either a Python int in [0, 2**128) or a 2-element uint64 array. If not provided, the counter is initialized at 0."><span class="n"><span class="pre">counter</span></span></a><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#randomgen.aes.AESCounter.__init__.key" title="randomgen.aes.AESCounter.__init__.key (Python parameter) — Key to use in the AESCounter state. Unlike seed, which is run through another RNG before use, the value in key is directly set. Can be either a Python int in [0, 2**128) or a 2-element uint64 array. key and seed cannot both be used."><span class="n"><span class="pre">key</span></span></a><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em>, </span><span class="sig-param-decl"><em class="sig-param"><a class="n reference internal" href="#randomgen.aes.AESCounter.__init__.mode" title="randomgen.aes.AESCounter.__init__.mode (Python parameter) — The seeding mode to use. &quot;legacy&quot; uses the legacy SplitMix64-based initialization. &quot;sequence&quot; uses a SeedSequence to transforms the seed into an initial state. None defaults to &quot;sequence&quot;."><span class="n"><span class="pre">mode</span></span></a><span class="o"><span class="pre">=</span></span><code class="code python default_value docutils literal highlight highlight-python"><span class="kc">None</span></code></em></span><span class="sig-paren">)</span><a class="headerlink" href="#randomgen.aes.AESCounter" title="Link to this definition"></a></dt>
<dd><p>Container for the AES Counter pseudo-random number generator.</p>
<dl class="field-list simple">
<dt class="field-odd" id="randomgen.aes.AESCounter-parameters">Parameters<span class="colon">:</span><a class="headerlink" href="#randomgen.aes.AESCounter-parameters" title="Permalink to this headline"></a></dt>
Expand Down Expand Up @@ -1639,7 +1639,7 @@ <h1 id="module-randomgen.aes"><span id="aes-counter-based-rng"></span>AES Counte
</dl>
<dl class="py attribute objdesc">
<dt class="sig sig-object highlight py" id="randomgen.aes.AESCounter.lock">
<span class="sig-name descname"><span class="pre">lock</span></span><a class="headerlink" href="#randomgen.aes.AESCounter.lock" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">lock</span></span><a class="headerlink" href="#randomgen.aes.AESCounter.lock" title="Link to this definition"></a></dt>
<dd><p>Lock instance that is shared so that the same bit git generator can
be used in multiple Generators without corrupting the state. Code that
generates values from a bit generator should hold the bit generator’s
Expand All @@ -1653,7 +1653,7 @@ <h1 id="module-randomgen.aes"><span id="aes-counter-based-rng"></span>AES Counte

<dl class="py attribute objdesc">
<dt class="sig sig-object highlight py" id="randomgen.aes.AESCounter.seed_seq">
<span class="sig-name descname"><span class="pre">seed_seq</span></span><a class="headerlink" href="#randomgen.aes.AESCounter.seed_seq" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">seed_seq</span></span><a class="headerlink" href="#randomgen.aes.AESCounter.seed_seq" title="Link to this definition"></a></dt>
<dd><p>The SeedSequence instance used to initialize the generator if mode is
“sequence” or is seed is a SeedSequence. None if mode is “legacy”.</p>
<dl class="field-list simple">
Expand Down Expand Up @@ -1731,7 +1731,7 @@ <h1 id="module-randomgen.aes"><span id="aes-counter-based-rng"></span>AES Counte
</aside>
</dd></dl>

<h2 id="seeding-and-state">Seeding and State<a class="headerlink" href="#seeding-and-state" title="Permalink to this heading"></a></h2>
<h2 id="seeding-and-state">Seeding and State<a class="headerlink" href="#seeding-and-state" title="Link to this heading"></a></h2>
<table class="autosummary longtable docutils data align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/randomgen.aes.AESCounter.seed.html#randomgen.aes.AESCounter.seed" title="randomgen.aes.AESCounter.seed (Python method) — Seed the generator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">seed</span></code></a>([seed, counter, key])</p></td>
Expand All @@ -1742,7 +1742,7 @@ <h2 id="seeding-and-state">Seeding and State<a class="headerlink" href="#seeding
</tr>
</tbody>
</table>
<h2 id="parallel-generation">Parallel generation<a class="headerlink" href="#parallel-generation" title="Permalink to this heading"></a></h2>
<h2 id="parallel-generation">Parallel generation<a class="headerlink" href="#parallel-generation" title="Link to this heading"></a></h2>
<table class="autosummary longtable docutils data align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/randomgen.aes.AESCounter.advance.html#randomgen.aes.AESCounter.advance" title="randomgen.aes.AESCounter.advance (Python method) — Advance the underlying RNG as-if delta draws have occurred."><code class="xref py py-obj docutils literal notranslate"><span class="pre">advance</span></code></a>(delta)</p></td>
Expand All @@ -1756,7 +1756,7 @@ <h2 id="parallel-generation">Parallel generation<a class="headerlink" href="#par
</tr>
</tbody>
</table>
<h2 id="extending">Extending<a class="headerlink" href="#extending" title="Permalink to this heading"></a></h2>
<h2 id="extending">Extending<a class="headerlink" href="#extending" title="Link to this heading"></a></h2>
<table class="autosummary longtable docutils data align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/randomgen.aes.AESCounter.cffi.html#randomgen.aes.AESCounter.cffi" title="randomgen.aes.AESCounter.cffi (Python attribute) — CFFI interface"><code class="xref py py-obj docutils literal notranslate"><span class="pre">cffi</span></code></a></p></td>
Expand All @@ -1767,7 +1767,7 @@ <h2 id="extending">Extending<a class="headerlink" href="#extending" title="Perma
</tr>
</tbody>
</table>
<h2 id="testing">Testing<a class="headerlink" href="#testing" title="Permalink to this heading"></a></h2>
<h2 id="testing">Testing<a class="headerlink" href="#testing" title="Link to this heading"></a></h2>
<table class="autosummary longtable docutils data align-default">
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="generated/randomgen.aes.AESCounter.random_raw.html#randomgen.aes.AESCounter.random_raw" title="randomgen.aes.AESCounter.random_raw (Python method) — Return randoms as generated by the underlying BitGenerator"><code class="xref py py-obj docutils literal notranslate"><span class="pre">random_raw</span></code></a>([size, output])</p></td>
Expand Down Expand Up @@ -1842,7 +1842,7 @@ <h2 id="testing">Testing<a class="headerlink" href="#testing" title="Permalink t

Created using
<a href="https://www.sphinx-doc.org/" target="_blank" rel="noopener">Sphinx</a>
7.1.2.
7.2.6.
and
<a href="https://github.com/jbms/sphinx-immaterial/" target="_blank" rel="noopener">Sphinx-Immaterial</a>

Expand Down
Loading

0 comments on commit 1f89bc9

Please sign in to comment.