read-the-docs action #1

Institute-for-Risk-and-Uncertainty · Dec 14, 2023 · 30715dd · 30715dd
1 parent 9a26508
commit 30715dd
Show file tree

Hide file tree

Showing 18 changed files with 173 additions and 205 deletions.
diff --git a/.github/workflows/documentation-links.yml b/.github/workflows/documentation-links.yml
@@ -0,0 +1,20 @@
+name: readthedocs/actions
+on:
+  pull_request_target:
+    types:
+      - opened
+    # Execute this action only on PRs that touch
+    # documentation files.
+    # paths:
+    #   - "docs/**"
+
+permissions:
+  pull-requests: write
+
+jobs:
+  documentation-links:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: readthedocs/actions/preview@v1
+        with:
+          project-slug: "readthedocs-preview"
diff --git a/docs/_build/doctrees/api/pba.dists.gibrat 2.doctree b/docs/_build/doctrees/api/pba.dists.gibrat 2.doctree
diff --git a/docs/_build/doctrees/api/pba.dists.gibrat.doctree b/docs/_build/doctrees/api/pba.dists.gibrat.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/source/pba.interval.doctree b/docs/_build/doctrees/source/pba.interval.doctree
diff --git a/docs/_build/doctrees/source/pba.pboxes 2.doctree b/docs/_build/doctrees/source/pba.pboxes 2.doctree
diff --git a/docs/_build/doctrees/source/pba.pboxes.doctree b/docs/_build/doctrees/source/pba.pboxes.doctree
diff --git a/docs/_build/html/api/pba.dists.geom.html b/docs/_build/html/api/pba.dists.geom.html
@@ -21,7 +21,7 @@
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="gibrat" href="pba.dists.gibrat.html" />
+    <link rel="next" title="gompertz" href="pba.dists.gompertz.html" />
     <link rel="prev" title="genpareto" href="pba.dists.genpareto.html" /> 
 </head>
 
@@ -86,7 +86,7 @@ <h1>geom<a class="headerlink" href="#geom" title="Permalink to this heading">
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="pba.dists.genpareto.html" class="btn btn-neutral float-left" title="genpareto" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="pba.dists.gibrat.html" class="btn btn-neutral float-right" title="gibrat" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="pba.dists.gompertz.html" class="btn btn-neutral float-right" title="gompertz" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

diff --git a/docs/_build/html/api/pba.dists.gibrat 2.html b/docs/_build/html/api/pba.dists.gibrat 2.html
@@ -71,11 +71,6 @@
 
   <section id="gibrat">
 <h1>gibrat<a class="headerlink" href="#gibrat" title="Permalink to this heading"></a></h1>
-<dl class="py function">
-<dt class="sig sig-object py" id="pba.dists.gibrat">
-<span class="sig-prename descclassname"><span class="pre">pba.dists.</span></span><span class="sig-name descname"><span class="pre">gibrat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">steps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">200</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pba.dists.gibrat" title="Permalink to this definition"></a></dt>
-<dd></dd></dl>
-
 </section>
 
 

diff --git a/docs/_build/html/api/pba.dists.gibrat.html b/docs/_build/html/api/pba.dists.gibrat.html
@@ -20,9 +20,7 @@
         <script src="../_static/sphinx_highlight.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
-    <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="gompertz" href="pba.dists.gompertz.html" />
-    <link rel="prev" title="geom" href="pba.dists.geom.html" /> 
+    <link rel="search" title="Search" href="../search.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -61,7 +59,6 @@
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
       <li><a href="../index.html" class="icon icon-home"></a></li>
-          <li class="breadcrumb-item"><a href="../source/pba.pboxes.html">Probability boxes</a></li>
       <li class="breadcrumb-item active">gibrat</li>
       <li class="wy-breadcrumbs-aside">
             <a href="../_sources/api/pba.dists.gibrat.rst.txt" rel="nofollow"> View page source</a>
@@ -74,20 +71,12 @@
 
   <section id="gibrat">
 <h1>gibrat<a class="headerlink" href="#gibrat" title="Permalink to this heading"></a></h1>
-<dl class="py function">
-<dt class="sig sig-object py" id="pba.dists.gibrat">
-<span class="sig-prename descclassname"><span class="pre">pba.dists.</span></span><span class="sig-name descname"><span class="pre">gibrat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">steps</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">200</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pba.dists.gibrat" title="Permalink to this definition"></a></dt>
-<dd></dd></dl>
-
 </section>
 
 
            </div>
           </div>
-          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="pba.dists.geom.html" class="btn btn-neutral float-left" title="geom" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="pba.dists.gompertz.html" class="btn btn-neutral float-right" title="gompertz" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
-    </div>
+          <footer>
 
   <hr/>
 

diff --git a/docs/_build/html/api/pba.dists.gompertz.html b/docs/_build/html/api/pba.dists.gompertz.html
@@ -22,7 +22,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="gumbel_l" href="pba.dists.gumbel_l.html" />
-    <link rel="prev" title="gibrat" href="pba.dists.gibrat.html" /> 
+    <link rel="prev" title="geom" href="pba.dists.geom.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -85,7 +85,7 @@ <h1>gompertz<a class="headerlink" href="#gompertz" title="Permalink to this head
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="pba.dists.gibrat.html" class="btn btn-neutral float-left" title="gibrat" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="pba.dists.geom.html" class="btn btn-neutral float-left" title="geom" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="pba.dists.gumbel_l.html" class="btn btn-neutral float-right" title="gumbel_l" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -165,8 +165,6 @@ <h2 id="C">C</h2>
       <li><a href="api/pba.copula.Clayton.html#pba.copula.Clayton">Clayton() (in module pba.copula)</a>
 </li>
       <li><a href="api/pba.copula.Copula.html#pba.copula.Copula">Copula (class in pba.copula)</a>
-</li>
-      <li><a href="source/pba.interval.html#pba.Interval.cos">cos() (pba.Interval method)</a>
 </li>
       <li><a href="api/pba.dists.cosine.html#pba.dists.cosine">cosine() (in module pba.dists)</a>
 </li>
@@ -289,8 +287,6 @@ <h2 id="G">G</h2>
       <li><a href="api/pba.pbox.Pbox.html#pba.pbox.Pbox.get_x">get_x() (pba.pbox.Pbox method)</a>
 </li>
       <li><a href="api/pba.pbox.Pbox.html#pba.pbox.Pbox.get_y">get_y() (pba.pbox.Pbox method)</a>
-</li>
-      <li><a href="api/pba.dists.gibrat%202.html#pba.dists.gibrat">gibrat() (in module pba.dists)</a>, <a href="api/pba.dists.gibrat.html#pba.dists.gibrat">[1]</a>
 </li>
       <li><a href="api/pba.dists.gompertz.html#pba.dists.gompertz">gompertz() (in module pba.dists)</a>
 </li>
@@ -650,8 +646,6 @@ <h2 id="S">S</h2>
 </li>
       </ul></li>
       <li><a href="api/pba.copula.Copula.html#pba.copula.Copula.showContour">showContour() (pba.copula.Copula method)</a>
-</li>
-      <li><a href="source/pba.interval.html#pba.Interval.sin">sin() (pba.Interval method)</a>
 </li>
       <li><a href="api/pba.dists.skellam.html#pba.dists.skellam">skellam() (in module pba.dists)</a>
 </li>
@@ -694,8 +688,6 @@ <h2 id="T">T</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api/pba.dists.t.html#pba.dists.t">t() (in module pba.dists)</a>
-</li>
-      <li><a href="source/pba.interval.html#pba.Interval.tan">tan() (pba.Interval method)</a>
 </li>
       <li><a href="source/pba.interval.html#pba.Interval.to_logical">to_logical() (pba.Interval method)</a>
 </li>

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -101,7 +101,6 @@ <h2>License<a class="headerlink" href="#license" title="Permalink to this headin
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="source/pba.interval.html">Intervals</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="source/pba.interval.html#pba.Interval"><code class="docutils literal notranslate"><span class="pre">Interval</span></code></a><ul>
-<li class="toctree-l3"><a class="reference internal" href="source/pba.interval.html#pba.Interval.cos"><code class="docutils literal notranslate"><span class="pre">Interval.cos()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="source/pba.interval.html#pba.Interval.equiv"><code class="docutils literal notranslate"><span class="pre">Interval.equiv()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="source/pba.interval.html#pba.Interval.exp"><code class="docutils literal notranslate"><span class="pre">Interval.exp()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="source/pba.interval.html#pba.Interval.hi"><code class="docutils literal notranslate"><span class="pre">Interval.hi()</span></code></a></li>
@@ -120,11 +119,9 @@ <h2>License<a class="headerlink" href="#license" title="Permalink to this headin
 <li class="toctree-l3"><a class="reference internal" href="source/pba.interval.html#pba.Interval.psub"><code class="docutils literal notranslate"><span class="pre">Interval.psub()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="source/pba.interval.html#pba.Interval.recip"><code class="docutils literal notranslate"><span class="pre">Interval.recip()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="source/pba.interval.html#pba.Interval.sample"><code class="docutils literal notranslate"><span class="pre">Interval.sample()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="source/pba.interval.html#pba.Interval.sin"><code class="docutils literal notranslate"><span class="pre">Interval.sin()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="source/pba.interval.html#pba.Interval.sqrt"><code class="docutils literal notranslate"><span class="pre">Interval.sqrt()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="source/pba.interval.html#pba.Interval.straddles"><code class="docutils literal notranslate"><span class="pre">Interval.straddles()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="source/pba.interval.html#pba.Interval.straddles_zero"><code class="docutils literal notranslate"><span class="pre">Interval.straddles_zero()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="source/pba.interval.html#pba.Interval.tan"><code class="docutils literal notranslate"><span class="pre">Interval.tan()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="source/pba.interval.html#pba.Interval.to_logical"><code class="docutils literal notranslate"><span class="pre">Interval.to_logical()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="source/pba.interval.html#pba.Interval.width"><code class="docutils literal notranslate"><span class="pre">Interval.width()</span></code></a></li>
 </ul>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/_build/html/source/pba.interval.html b/docs/_build/html/source/pba.interval.html
@@ -45,7 +45,6 @@
 <ul class="current">
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Intervals</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#pba.Interval"><code class="docutils literal notranslate"><span class="pre">Interval</span></code></a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#pba.Interval.cos"><code class="docutils literal notranslate"><span class="pre">Interval.cos()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pba.Interval.equiv"><code class="docutils literal notranslate"><span class="pre">Interval.equiv()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pba.Interval.exp"><code class="docutils literal notranslate"><span class="pre">Interval.exp()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pba.Interval.hi"><code class="docutils literal notranslate"><span class="pre">Interval.hi()</span></code></a></li>
@@ -64,11 +63,9 @@
 <li class="toctree-l3"><a class="reference internal" href="#pba.Interval.psub"><code class="docutils literal notranslate"><span class="pre">Interval.psub()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pba.Interval.recip"><code class="docutils literal notranslate"><span class="pre">Interval.recip()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pba.Interval.sample"><code class="docutils literal notranslate"><span class="pre">Interval.sample()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#pba.Interval.sin"><code class="docutils literal notranslate"><span class="pre">Interval.sin()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pba.Interval.sqrt"><code class="docutils literal notranslate"><span class="pre">Interval.sqrt()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pba.Interval.straddles"><code class="docutils literal notranslate"><span class="pre">Interval.straddles()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pba.Interval.straddles_zero"><code class="docutils literal notranslate"><span class="pre">Interval.straddles_zero()</span></code></a></li>
-<li class="toctree-l3"><a class="reference internal" href="#pba.Interval.tan"><code class="docutils literal notranslate"><span class="pre">Interval.tan()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pba.Interval.to_logical"><code class="docutils literal notranslate"><span class="pre">Interval.to_logical()</span></code></a></li>
 <li class="toctree-l3"><a class="reference internal" href="#pba.Interval.width"><code class="docutils literal notranslate"><span class="pre">Interval.width()</span></code></a></li>
 </ul>
@@ -131,11 +128,6 @@ <h1>Intervals<a class="headerlink" href="#intervals" title="Permalink to this he
 </ul>
 </dd>
 </dl>
-<dl class="py method">
-<dt class="sig sig-object py" id="pba.Interval.cos">
-<span class="sig-name descname"><span class="pre">cos</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pba.Interval.cos" title="Permalink to this definition"></a></dt>
-<dd></dd></dl>
-
 <dl class="py method">
 <dt class="sig sig-object py" id="pba.Interval.equiv">
 <span class="sig-name descname"><span class="pre">equiv</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">other</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#pba.Interval.equiv" title="Permalink to this definition"></a></dt>
@@ -252,11 +244,6 @@ <h1>Intervals<a class="headerlink" href="#intervals" title="Permalink to this he
 <dd><p>Returns a random value from within the interval</p>
 </dd></dl>
 
-<dl class="py method">
-<dt class="sig sig-object py" id="pba.Interval.sin">
-<span class="sig-name descname"><span class="pre">sin</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pba.Interval.sin" title="Permalink to this definition"></a></dt>
-<dd></dd></dl>
-
 <dl class="py method">
 <dt class="sig sig-object py" id="pba.Interval.sqrt">
 <span class="sig-name descname"><span class="pre">sqrt</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pba.Interval.sqrt" title="Permalink to this definition"></a></dt>
@@ -288,11 +275,6 @@ <h1>Intervals<a class="headerlink" href="#intervals" title="Permalink to this he
 <dd><p>Checks whether <span class="math notranslate nohighlight">\(0\)</span> is within the interval</p>
 </dd></dl>
 
-<dl class="py method">
-<dt class="sig sig-object py" id="pba.Interval.tan">
-<span class="sig-name descname"><span class="pre">tan</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pba.Interval.tan" title="Permalink to this definition"></a></dt>
-<dd></dd></dl>
-
 <dl class="py method">
 <dt class="sig sig-object py" id="pba.Interval.to_logical">
 <span class="sig-name descname"><span class="pre">to_logical</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#pba.Interval.to_logical" title="Permalink to this definition"></a></dt>