Bot: Auto-Generation of the docs/ folder

COMSOC-Community · Nov 13, 2024 · 682340d · 682340d
1 parent 3c2a8d5
commit 682340d
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 26 deletions.
diff --git a/docs/reference/election/profile.html b/docs/reference/election/profile.html
@@ -1733,11 +1733,13 @@ <h2> Contents </h2>
 <span class="go">[&#39;A&#39;, &#39;A&#39;, &#39;B&#39;, &#39;B&#39;, &#39;C&#39;, &#39;C&#39;]</span>
 </pre></div>
 </div>
-<p># Knuth’s example for prime factors of 1836:  2**2 * 3**3 * 17**1
-&gt;&gt;&gt; import math
-&gt;&gt;&gt; prime_factors = Counter({2: 2, 3: 3, 17: 1})
-&gt;&gt;&gt; math.prod(prime_factors.elements())
-1836</p>
+<p>Knuth’s example for prime factors of 1836:  2**2 * 3**3 * 17**1</p>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">math</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">prime_factors</span> <span class="o">=</span> <span class="n">Counter</span><span class="p">({</span><span class="mi">2</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">17</span><span class="p">:</span> <span class="mi">1</span><span class="p">})</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">math</span><span class="o">.</span><span class="n">prod</span><span class="p">(</span><span class="n">prime_factors</span><span class="o">.</span><span class="n">elements</span><span class="p">())</span>
+<span class="go">1836</span>
+</pre></div>
+</div>
 <p>Note, if an element’s count has been set to zero or is a negative
 number, elements() will ignore it.</p>
 </dd></dl>
@@ -2516,11 +2518,13 @@ <h2> Contents </h2>
 <span class="go">[&#39;A&#39;, &#39;A&#39;, &#39;B&#39;, &#39;B&#39;, &#39;C&#39;, &#39;C&#39;]</span>
 </pre></div>
 </div>
-<p># Knuth’s example for prime factors of 1836:  2**2 * 3**3 * 17**1
-&gt;&gt;&gt; import math
-&gt;&gt;&gt; prime_factors = Counter({2: 2, 3: 3, 17: 1})
-&gt;&gt;&gt; math.prod(prime_factors.elements())
-1836</p>
+<p>Knuth’s example for prime factors of 1836:  2**2 * 3**3 * 17**1</p>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">math</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">prime_factors</span> <span class="o">=</span> <span class="n">Counter</span><span class="p">({</span><span class="mi">2</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">17</span><span class="p">:</span> <span class="mi">1</span><span class="p">})</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">math</span><span class="o">.</span><span class="n">prod</span><span class="p">(</span><span class="n">prime_factors</span><span class="o">.</span><span class="n">elements</span><span class="p">())</span>
+<span class="go">1836</span>
+</pre></div>
+</div>
 <p>Note, if an element’s count has been set to zero or is a negative
 number, elements() will ignore it.</p>
 </dd></dl>
@@ -3319,11 +3323,13 @@ <h2> Contents </h2>
 <span class="go">[&#39;A&#39;, &#39;A&#39;, &#39;B&#39;, &#39;B&#39;, &#39;C&#39;, &#39;C&#39;]</span>
 </pre></div>
 </div>
-<p># Knuth’s example for prime factors of 1836:  2**2 * 3**3 * 17**1
-&gt;&gt;&gt; import math
-&gt;&gt;&gt; prime_factors = Counter({2: 2, 3: 3, 17: 1})
-&gt;&gt;&gt; math.prod(prime_factors.elements())
-1836</p>
+<p>Knuth’s example for prime factors of 1836:  2**2 * 3**3 * 17**1</p>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">math</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">prime_factors</span> <span class="o">=</span> <span class="n">Counter</span><span class="p">({</span><span class="mi">2</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">17</span><span class="p">:</span> <span class="mi">1</span><span class="p">})</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">math</span><span class="o">.</span><span class="n">prod</span><span class="p">(</span><span class="n">prime_factors</span><span class="o">.</span><span class="n">elements</span><span class="p">())</span>
+<span class="go">1836</span>
+</pre></div>
+</div>
 <p>Note, if an element’s count has been set to zero or is a negative
 number, elements() will ignore it.</p>
 </dd></dl>
@@ -3934,11 +3940,13 @@ <h2> Contents </h2>
 <span class="go">[&#39;A&#39;, &#39;A&#39;, &#39;B&#39;, &#39;B&#39;, &#39;C&#39;, &#39;C&#39;]</span>
 </pre></div>
 </div>
-<p># Knuth’s example for prime factors of 1836:  2**2 * 3**3 * 17**1
-&gt;&gt;&gt; import math
-&gt;&gt;&gt; prime_factors = Counter({2: 2, 3: 3, 17: 1})
-&gt;&gt;&gt; math.prod(prime_factors.elements())
-1836</p>
+<p>Knuth’s example for prime factors of 1836:  2**2 * 3**3 * 17**1</p>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">math</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">prime_factors</span> <span class="o">=</span> <span class="n">Counter</span><span class="p">({</span><span class="mi">2</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">17</span><span class="p">:</span> <span class="mi">1</span><span class="p">})</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">math</span><span class="o">.</span><span class="n">prod</span><span class="p">(</span><span class="n">prime_factors</span><span class="o">.</span><span class="n">elements</span><span class="p">())</span>
+<span class="go">1836</span>
+</pre></div>
+</div>
 <p>Note, if an element’s count has been set to zero or is a negative
 number, elements() will ignore it.</p>
 </dd></dl>

diff --git a/docs/reference/election/satisfaction.html b/docs/reference/election/satisfaction.html
@@ -883,11 +883,13 @@ <h2> Contents </h2>
 <span class="go">[&#39;A&#39;, &#39;A&#39;, &#39;B&#39;, &#39;B&#39;, &#39;C&#39;, &#39;C&#39;]</span>
 </pre></div>
 </div>
-<p># Knuth’s example for prime factors of 1836:  2**2 * 3**3 * 17**1
-&gt;&gt;&gt; import math
-&gt;&gt;&gt; prime_factors = Counter({2: 2, 3: 3, 17: 1})
-&gt;&gt;&gt; math.prod(prime_factors.elements())
-1836</p>
+<p>Knuth’s example for prime factors of 1836:  2**2 * 3**3 * 17**1</p>
+<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">math</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">prime_factors</span> <span class="o">=</span> <span class="n">Counter</span><span class="p">({</span><span class="mi">2</span><span class="p">:</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">:</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">17</span><span class="p">:</span> <span class="mi">1</span><span class="p">})</span>
+<span class="gp">&gt;&gt;&gt; </span><span class="n">math</span><span class="o">.</span><span class="n">prod</span><span class="p">(</span><span class="n">prime_factors</span><span class="o">.</span><span class="n">elements</span><span class="p">())</span>
+<span class="go">1836</span>
+</pre></div>
+</div>
 <p>Note, if an element’s count has been set to zero or is a negative
 number, elements() will ignore it.</p>
 </dd></dl>

diff --git a/docs/reference/rules/index.html b/docs/reference/rules/index.html
@@ -761,7 +761,7 @@ <h2>Cumulative Support Transfer Voting Rule<a class="headerlink" href="#cumulati
 
 <dl class="py class">
 <dt class="sig sig-object py" id="pabutools.rules.cstv.CSTV_Combination">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CSTV_Combination</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pabutools/rules/cstv.html#CSTV_Combination"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pabutools.rules.cstv.CSTV_Combination" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CSTV_Combination</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names=&lt;not</span> <span class="pre">given&gt;</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">*values</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">module=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type=None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start=1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary=None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/pabutools/rules/cstv.html#CSTV_Combination"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pabutools.rules.cstv.CSTV_Combination" title="Link to this definition">#</a></dt>
 <dd><dl class="py attribute">
 <dt class="sig sig-object py" id="pabutools.rules.cstv.CSTV_Combination.EWT">
 <span class="sig-name descname"><span class="pre">EWT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#pabutools.rules.cstv.CSTV_Combination.EWT" title="Link to this definition">#</a></dt>