Update docs after building Travis build 327 of

Quansight/ndindex The docs were built from the branch 'master' against the commit d15a974. The Travis build that generated this commit is at https://travis-ci.org/Quansight/ndindex/jobs/721444584. The doctr command that was run is /home/travis/miniconda/envs/test-environment/bin/doctr deploy .
Quansight-Labs · Aug 26, 2020 · e88befd · e88befd
1 parent 98f68ef
commit e88befd
Show file tree

Hide file tree

Showing 12 changed files with 108 additions and 28 deletions.
diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -97,3 +97,5 @@ These classes are only intended for internal use in ndindex.
 .. autoclass:: ndindex.slice.default
 
 .. autofunction:: ndindex.ndindex.asshape
+
+.. autofunction:: ndindex.ndindex.operator_index
diff --git a/_sources/type-confusion.md.txt b/_sources/type-confusion.md.txt
@@ -208,7 +208,10 @@ Additionally, some advice for specific types:
 
 - `ellipsis` is **not** singletonized, unlike the built-in `...`. It would
   also be impossible to make `ellipsis() is ...` return True. If you are using
-  ndindex, **you should use `==` to compare against `...`**, and avoid using `is`.
+  ndindex, **you should use `==` to compare against `...`**, and avoid using
+  `is`. Note that as long as you know `idx` is an ndindex type, this is safe
+  to do, since even the array index types `IntegerArray` and `BooleanArray`
+  allow `==` comparison (unlike NumPy arrays).
 
   **Right:**
 
@@ -278,7 +281,10 @@ Note that `np.newaxis` is just an alias for `None`.
 - `Newaxis` is **not** singletonized, unlike the built-in `None`. It would
   also be impossible to make `Newaxis() is np.newaxis` or `Newaxis() is None`
   return True. If you are using ndindex, **you should use `==` to compare
-  against `np.newaxis` or `None`**, and avoid using `is`.
+  against `np.newaxis` or `None`**, and avoid using `is`. Note that as long as
+  you know `idx` is an ndindex type, this is safe to do, since even the array
+  index types `IntegerArray` and `BooleanArray` allow `==` comparison (unlike
+  NumPy arrays).
 
   **Right:**
 

diff --git a/api.html b/api.html
diff --git a/changelog.html b/changelog.html
@@ -14,7 +14,7 @@
     <script src="_static/doctools.js"></script>
     <script src="_static/language_data.js"></script>
     <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
-    <script type="text/x-mathjax-config">MathJax.Hub.Config({"TeX": {"equationNumbers": {"autoNumber": "AMS"}}})</script>
+    <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["\\(", "\\)"]], "displayMath": [["\\[", "\\]"]], "processRefs": false, "processEnvironments": false}})</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Documentation Style Guide" href="style-guide.html" />
@@ -395,7 +395,7 @@ <h3 id="searchlabel">Quick search</h3>
       &copy;2020, Quansight.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.0</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.1</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
       |

diff --git a/genindex.html b/genindex.html
@@ -14,7 +14,7 @@
     <script src="_static/doctools.js"></script>
     <script src="_static/language_data.js"></script>
     <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
-    <script type="text/x-mathjax-config">MathJax.Hub.Config({"TeX": {"equationNumbers": {"autoNumber": "AMS"}}})</script>
+    <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["\\(", "\\)"]], "displayMath": [["\\[", "\\]"]], "processRefs": false, "processEnvironments": false}})</script>
     <link rel="index" title="Index" href="#" />
     <link rel="search" title="Search" href="search.html" />
 
@@ -56,6 +56,7 @@ <h1 id="index">Index</h1>
  | <a href="#H"><strong>H</strong></a>
  | <a href="#I"><strong>I</strong></a>
  | <a href="#N"><strong>N</strong></a>
+ | <a href="#O"><strong>O</strong></a>
  | <a href="#R"><strong>R</strong></a>
  | <a href="#S"><strong>S</strong></a>
  | <a href="#T"><strong>T</strong></a>
@@ -108,6 +109,8 @@ <h2 id="_">_</h2>
         <li><a href="api.html#ndindex.BooleanArray.__str__">(ndindex.BooleanArray method)</a>
 </li>
         <li><a href="api.html#ndindex.IntegerArray.__str__">(ndindex.IntegerArray method)</a>
+</li>
+        <li><a href="api.html#ndindex.Tuple.__str__">(ndindex.Tuple method)</a>
 </li>
       </ul></li>
       <li><a href="api.html#ndindex.BooleanArray.__weakref__">__weakref__ (ndindex.BooleanArray attribute)</a>
@@ -281,6 +284,14 @@ <h2 id="N">N</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="O">O</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#ndindex.ndindex.operator_index">operator_index() (in module ndindex.ndindex)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
@@ -572,7 +583,7 @@ <h3 id="searchlabel">Quick search</h3>
       &copy;2020, Quansight.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.0</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.1</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
     </div>

diff --git a/index.html b/index.html
@@ -14,7 +14,7 @@
     <script src="_static/doctools.js"></script>
     <script src="_static/language_data.js"></script>
     <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
-    <script type="text/x-mathjax-config">MathJax.Hub.Config({"TeX": {"equationNumbers": {"autoNumber": "AMS"}}})</script>
+    <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["\\(", "\\)"]], "displayMath": [["\\[", "\\]"]], "processRefs": false, "processEnvironments": false}})</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="API Reference" href="api.html" />
@@ -656,7 +656,7 @@ <h3 id="searchlabel">Quick search</h3>
       &copy;2020, Quansight.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.0</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.1</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
       |

diff --git a/objects.inv b/objects.inv
diff --git a/search.html b/search.html
@@ -15,7 +15,7 @@
     <script src="_static/doctools.js"></script>
     <script src="_static/language_data.js"></script>
     <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
-    <script type="text/x-mathjax-config">MathJax.Hub.Config({"TeX": {"equationNumbers": {"autoNumber": "AMS"}}})</script>
+    <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["\\(", "\\)"]], "displayMath": [["\\[", "\\]"]], "processRefs": false, "processEnvironments": false}})</script>
     <script src="_static/searchtools.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="#" />
@@ -263,7 +263,7 @@ <h1 class="logo"><a href="index.html">ndindex</a></h1>
       &copy;2020, Quansight.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.0</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.1</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
     </div>

diff --git a/searchindex.js b/searchindex.js
diff --git a/slices.html b/slices.html
@@ -14,7 +14,7 @@
     <script src="_static/doctools.js"></script>
     <script src="_static/language_data.js"></script>
     <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
-    <script type="text/x-mathjax-config">MathJax.Hub.Config({"TeX": {"equationNumbers": {"autoNumber": "AMS"}}})</script>
+    <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["\\(", "\\)"]], "displayMath": [["\\[", "\\]"]], "processRefs": false, "processEnvironments": false}})</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Type Confusion" href="type-confusion.html" />
@@ -2082,7 +2082,7 @@ <h3 id="searchlabel">Quick search</h3>
       &copy;2020, Quansight.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.0</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.1</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
       |

diff --git a/style-guide.html b/style-guide.html
@@ -14,7 +14,7 @@
     <script src="_static/doctools.js"></script>
     <script src="_static/language_data.js"></script>
     <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
-    <script type="text/x-mathjax-config">MathJax.Hub.Config({"TeX": {"equationNumbers": {"autoNumber": "AMS"}}})</script>
+    <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["\\(", "\\)"]], "displayMath": [["\\[", "\\]"]], "processRefs": false, "processEnvironments": false}})</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="prev" title="ndindex Changelog" href="changelog.html" />
@@ -323,7 +323,7 @@ <h3 id="searchlabel">Quick search</h3>
       &copy;2020, Quansight.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.0</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.1</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
       |

diff --git a/type-confusion.html b/type-confusion.html
@@ -14,7 +14,7 @@
     <script src="_static/doctools.js"></script>
     <script src="_static/language_data.js"></script>
     <script async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/latest.js?config=TeX-AMS-MML_HTMLorMML"></script>
-    <script type="text/x-mathjax-config">MathJax.Hub.Config({"TeX": {"equationNumbers": {"autoNumber": "AMS"}}})</script>
+    <script type="text/x-mathjax-config">MathJax.Hub.Config({"tex2jax": {"inlineMath": [["\\(", "\\)"]], "displayMath": [["\\[", "\\]"]], "processRefs": false, "processEnvironments": false}})</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="ndindex Changelog" href="changelog.html" />
@@ -225,7 +225,10 @@ <h2>ellipsis<a class="headerlink" href="#ellipsis" title="Permalink to this head
 </li>
 <li><p><code class="docutils literal notranslate"><span class="pre">ellipsis</span></code> is <strong>not</strong> singletonized, unlike the built-in <code class="docutils literal notranslate"><span class="pre">...</span></code>. It would
 also be impossible to make <code class="docutils literal notranslate"><span class="pre">ellipsis()</span> <span class="pre">is</span> <span class="pre">...</span></code> return True. If you are using
-ndindex, <strong>you should use <code class="docutils literal notranslate"><span class="pre">==</span></code> to compare against <code class="docutils literal notranslate"><span class="pre">...</span></code></strong>, and avoid using <code class="docutils literal notranslate"><span class="pre">is</span></code>.</p>
+ndindex, <strong>you should use <code class="docutils literal notranslate"><span class="pre">==</span></code> to compare against <code class="docutils literal notranslate"><span class="pre">...</span></code></strong>, and avoid using
+<code class="docutils literal notranslate"><span class="pre">is</span></code>. Note that as long as you know <code class="docutils literal notranslate"><span class="pre">idx</span></code> is an ndindex type, this is safe
+to do, since even the array index types <code class="docutils literal notranslate"><span class="pre">IntegerArray</span></code> and <code class="docutils literal notranslate"><span class="pre">BooleanArray</span></code>
+allow <code class="docutils literal notranslate"><span class="pre">==</span></code> comparison (unlike NumPy arrays).</p>
 <p><strong>Right:</strong></p>
 <div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="n">idx</span> <span class="o">==</span> <span class="o">...</span><span class="p">:</span>
 </pre></div>
@@ -282,7 +285,10 @@ <h2>Newaxis<a class="headerlink" href="#newaxis" title="Permalink to this headli
 <li><p><code class="docutils literal notranslate"><span class="pre">Newaxis</span></code> is <strong>not</strong> singletonized, unlike the built-in <code class="docutils literal notranslate"><span class="pre">None</span></code>. It would
 also be impossible to make <code class="docutils literal notranslate"><span class="pre">Newaxis()</span> <span class="pre">is</span> <span class="pre">np.newaxis</span></code> or <code class="docutils literal notranslate"><span class="pre">Newaxis()</span> <span class="pre">is</span> <span class="pre">None</span></code>
 return True. If you are using ndindex, <strong>you should use <code class="docutils literal notranslate"><span class="pre">==</span></code> to compare
-against <code class="docutils literal notranslate"><span class="pre">np.newaxis</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code></strong>, and avoid using <code class="docutils literal notranslate"><span class="pre">is</span></code>.</p>
+against <code class="docutils literal notranslate"><span class="pre">np.newaxis</span></code> or <code class="docutils literal notranslate"><span class="pre">None</span></code></strong>, and avoid using <code class="docutils literal notranslate"><span class="pre">is</span></code>. Note that as long as
+you know <code class="docutils literal notranslate"><span class="pre">idx</span></code> is an ndindex type, this is safe to do, since even the array
+index types <code class="docutils literal notranslate"><span class="pre">IntegerArray</span></code> and <code class="docutils literal notranslate"><span class="pre">BooleanArray</span></code> allow <code class="docutils literal notranslate"><span class="pre">==</span></code> comparison (unlike
+NumPy arrays).</p>
 <p><strong>Right:</strong></p>
 <div class="highlight-py notranslate"><div class="highlight"><pre><span></span><span class="k">if</span> <span class="n">idx</span> <span class="o">==</span> <span class="n">np</span><span class="o">.</span><span class="n">newaxis</span><span class="p">:</span>
 </pre></div>
@@ -551,7 +557,7 @@ <h3 id="searchlabel">Quick search</h3>
       &copy;2020, Quansight.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.0</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.1</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
       |