Merge pull request #35 from nrc-cnrc/hotfix

Hotfix
nrc-cnrc · May 13, 2022 · fa9e94c · fa9e94c
2 parents cd1d422 + 698a187
commit fa9e94c
Show file tree

Hide file tree

Showing 40 changed files with 1,775 additions and 864 deletions.
diff --git a/dist/metrolopy-0.6.2.tar.gz b/dist/metrolopy-0.6.2.tar.gz
diff --git a/dist/metrolopy-0.6.2-py3-none-any.whl → dist/metrolopy-0.6.3-py3-none-any.whl b/dist/metrolopy-0.6.2-py3-none-any.whl → dist/metrolopy-0.6.3-py3-none-any.whl
diff --git a/dist/metrolopy-0.6.3.tar.gz b/dist/metrolopy-0.6.3.tar.gz
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/hand_made_doc.doctree b/docs/_build/doctrees/hand_made_doc.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/metrolopy.doctree b/docs/_build/doctrees/metrolopy.doctree
diff --git a/docs/_build/doctrees/metrolopy.tests.doctree b/docs/_build/doctrees/metrolopy.tests.doctree
diff --git a/docs/_build/doctrees/modules.doctree b/docs/_build/doctrees/modules.doctree
diff --git a/docs/_build/doctrees/todo.doctree b/docs/_build/doctrees/todo.doctree
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -133,6 +133,7 @@ version history
   as well as a library of physical constants.
 * Version 0.6.1 built 19 October 2020, bug fixes
 * Version 0.6.2 built 10 July 2021, bug fixes
+* Version 0.6.3 built 13 May 2022, bug fixes
 
 
 author

diff --git a/docs/_build/html/_static/basic.css b/docs/_build/html/_static/basic.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- basic theme.
  *
- * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -731,8 +731,9 @@ dl.glossary dt {
 
 .classifier:before {
     font-style: normal;
-    margin: 0.5em;
+    margin: 0 0.5em;
     content: ":";
+    display: inline-block;
 }
 
 abbr, acronym {
@@ -756,6 +757,7 @@ span.pre {
     -ms-hyphens: none;
     -webkit-hyphens: none;
     hyphens: none;
+    white-space: nowrap;
 }
 
 div[class*="highlight-"] {
@@ -819,7 +821,7 @@ div.code-block-caption code {
 
 table.highlighttable td.linenos,
 span.linenos,
-div.doctest > div.highlight span.gp {  /* gp: Generic.Prompt */
+div.highlight span.gp {  /* gp: Generic.Prompt */
   user-select: none;
   -webkit-user-select: text; /* Safari fallback only */
   -webkit-user-select: none; /* Chrome/Safari */

diff --git a/docs/_build/html/_static/doctools.js b/docs/_build/html/_static/doctools.js
@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for all documentation.
  *
- * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -154,9 +154,7 @@ var Documentation = {
     this.fixFirefoxAnchorBug();
     this.highlightSearchWords();
     this.initIndexTable();
-    if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
-      this.initOnKeyListeners();
-    }
+    this.initOnKeyListeners();
   },
 
   /**
@@ -264,6 +262,16 @@ var Documentation = {
   hideSearchWords : function() {
     $('#searchbox .highlight-link').fadeOut(300);
     $('span.highlighted').removeClass('highlighted');
+    var url = new URL(window.location);
+    url.searchParams.delete('highlight');
+    window.history.replaceState({}, '', url);
+  },
+
+   /**
+   * helper function to focus on search bar
+   */
+  focusSearchBar : function() {
+    $('input[name=q]').first().focus();
   },
 
   /**
@@ -288,25 +296,54 @@ var Documentation = {
   },
 
   initOnKeyListeners: function() {
+    // only install a listener if it is really needed
+    if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
+        !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
+        return;
+
     $(document).keydown(function(event) {
       var activeElementType = document.activeElement.tagName;
       // don't navigate when in search box, textarea, dropdown or button
       if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
-          && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
-          && !event.shiftKey) {
-        switch (event.keyCode) {
-          case 37: // left
-            var prevHref = $('link[rel="prev"]').prop('href');
-            if (prevHref) {
-              window.location.href = prevHref;
-              return false;
-            }
-          case 39: // right
-            var nextHref = $('link[rel="next"]').prop('href');
-            if (nextHref) {
-              window.location.href = nextHref;
-              return false;
-            }
+          && activeElementType !== 'BUTTON') {
+        if (event.altKey || event.ctrlKey || event.metaKey)
+          return;
+
+          if (!event.shiftKey) {
+            switch (event.key) {
+              case 'ArrowLeft':
+                if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
+                  break;
+                var prevHref = $('link[rel="prev"]').prop('href');
+                if (prevHref) {
+                  window.location.href = prevHref;
+                  return false;
+                }
+                break;
+              case 'ArrowRight':
+                if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS)
+                  break;
+                var nextHref = $('link[rel="next"]').prop('href');
+                if (nextHref) {
+                  window.location.href = nextHref;
+                  return false;
+                }
+                break;
+              case 'Escape':
+                if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
+                  break;
+                Documentation.hideSearchWords();
+                return false;
+          }
+        }
+
+        // some keyboard layouts may need Shift to get /
+        switch (event.key) {
+          case '/':
+            if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS)
+              break;
+            Documentation.focusSearchBar();
+            return false;
         }
       }
     });

diff --git a/docs/_build/html/_static/nature.css b/docs/_build/html/_static/nature.css
@@ -4,7 +4,7 @@
  *
  * Sphinx stylesheet -- nature theme.
  *
- * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */

diff --git a/docs/_build/html/_static/searchtools.js b/docs/_build/html/_static/searchtools.js
@@ -4,7 +4,7 @@
  *
  * Sphinx JavaScript utilities for the full-text search.
  *
- * :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
  * :license: BSD, see LICENSE for details.
  *
  */
@@ -172,10 +172,6 @@ var Search = {
       }
       // stem the word
       var word = stemmer.stemWord(tmp[i].toLowerCase());
-      // prevent stemmer from cutting word smaller than two chars
-      if(word.length < 3 && tmp[i].length >= 3) {
-        word = tmp[i];
-      }
       var toAppend;
       // select the correct list
       if (word[0] == '-') {
@@ -276,21 +272,24 @@ var Search = {
           setTimeout(function() {
             displayNextItem();
           }, 5);
-        } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
+        } else if (DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY) {
           $.ajax({url: requestUrl,
                   dataType: "text",
                   complete: function(jqxhr, textstatus) {
                     var data = jqxhr.responseText;
                     if (data !== '' && data !== undefined) {
-                      listItem.append(Search.makeSearchSummary(data, searchterms, hlterms));
+                      var summary = Search.makeSearchSummary(data, searchterms, hlterms);
+                      if (summary) {
+                        listItem.append(summary);
+                      }
                     }
                     Search.output.append(listItem);
                     setTimeout(function() {
                       displayNextItem();
                     }, 5);
                   }});
         } else {
-          // no source available, just display title
+          // just display title
           Search.output.append(listItem);
           setTimeout(function() {
             displayNextItem();
@@ -325,7 +324,9 @@ var Search = {
     var results = [];
 
     for (var prefix in objects) {
-      for (var name in objects[prefix]) {
+      for (var iMatch = 0; iMatch != objects[prefix].length; ++iMatch) {
+        var match = objects[prefix][iMatch];
+        var name = match[4];
         var fullname = (prefix ? prefix + '.' : '') + name;
         var fullnameLower = fullname.toLowerCase()
         if (fullnameLower.indexOf(object) > -1) {
@@ -339,7 +340,6 @@ var Search = {
           } else if (parts[parts.length - 1].indexOf(object) > -1) {
             score += Scorer.objPartialMatch;
           }
-          var match = objects[prefix][name];
           var objname = objnames[match[1]][2];
           var title = titles[match[0]];
           // If more than one term searched for, we require other words to be
@@ -498,6 +498,9 @@ var Search = {
    */
   makeSearchSummary : function(htmlText, keywords, hlwords) {
     var text = Search.htmlToText(htmlText);
+    if (text == "") {
+      return null;
+    }
     var textLower = text.toLowerCase();
     var start = 0;
     $.each(keywords, function() {

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; metrolopy 0.6.2 documentation</title>
+    <title>Index &#8212; metrolopy 0.6.3 documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/nature.css" />
     <script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -24,7 +24,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">metrolopy 0.6.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">metrolopy 0.6.3 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Index</a></li> 
       </ul>
     </div>  
@@ -255,24 +255,32 @@ <h2 id="C">C</h2>
         <li><a href="metrolopy.html#metrolopy.unit.Quantity.copy">(metrolopy.unit.Quantity method)</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="metrolopy.html#metrolopy.gummy.gummy.correlation">correlation() (metrolopy.gummy.gummy method)</a>
 
       <ul>
         <li><a href="metrolopy.html#metrolopy.ummy.ummy.correlation">(metrolopy.ummy.ummy method)</a>
 </li>
       </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="metrolopy.html#metrolopy.gummy.gummy.correlation_matrix">correlation_matrix() (metrolopy.gummy.gummy static method)</a>
 
       <ul>
         <li><a href="metrolopy.html#metrolopy.ummy.ummy.correlation_matrix">(metrolopy.ummy.ummy static method)</a>
 </li>
       </ul></li>
-      <li><a href="metrolopy.html#metrolopy.nummy.nummy.correlation_matrix_sim">correlation_matrix_sim() (metrolopy.nummy.nummy static method)</a>
+      <li><a href="metrolopy.html#metrolopy.gummy.gummy.correlation_matrix_sim">correlation_matrix_sim() (metrolopy.gummy.gummy static method)</a>
+
+      <ul>
+        <li><a href="metrolopy.html#metrolopy.nummy.nummy.correlation_matrix_sim">(metrolopy.nummy.nummy static method)</a>
 </li>
-      <li><a href="metrolopy.html#metrolopy.nummy.nummy.correlation_sim">correlation_sim() (metrolopy.nummy.nummy method)</a>
+      </ul></li>
+      <li><a href="metrolopy.html#metrolopy.gummy.gummy.correlation_sim">correlation_sim() (metrolopy.gummy.gummy method)</a>
+
+      <ul>
+        <li><a href="metrolopy.html#metrolopy.nummy.nummy.correlation_sim">(metrolopy.nummy.nummy method)</a>
 </li>
+      </ul></li>
       <li><a href="metrolopy.html#metrolopy.functions.cos">cos() (in module metrolopy.functions)</a>
 </li>
       <li><a href="metrolopy.html#metrolopy.functions.cosh">cosh() (in module metrolopy.functions)</a>
@@ -319,10 +327,18 @@ <h2 id="C">C</h2>
         <li><a href="metrolopy.html#metrolopy.ummy.ummy.covariance_matrix">(metrolopy.ummy.ummy static method)</a>
 </li>
       </ul></li>
-      <li><a href="metrolopy.html#metrolopy.nummy.nummy.covariance_matrix_sim">covariance_matrix_sim() (metrolopy.nummy.nummy static method)</a>
+      <li><a href="metrolopy.html#metrolopy.gummy.gummy.covariance_matrix_sim">covariance_matrix_sim() (metrolopy.gummy.gummy static method)</a>
+
+      <ul>
+        <li><a href="metrolopy.html#metrolopy.nummy.nummy.covariance_matrix_sim">(metrolopy.nummy.nummy static method)</a>
 </li>
-      <li><a href="metrolopy.html#metrolopy.nummy.nummy.covariance_sim">covariance_sim() (metrolopy.nummy.nummy method)</a>
+      </ul></li>
+      <li><a href="metrolopy.html#metrolopy.gummy.gummy.covariance_sim">covariance_sim() (metrolopy.gummy.gummy method)</a>
+
+      <ul>
+        <li><a href="metrolopy.html#metrolopy.nummy.nummy.covariance_sim">(metrolopy.nummy.nummy method)</a>
 </li>
+      </ul></li>
       <li><a href="metrolopy.html#metrolopy.pmethod.coverage_factor">coverage_factor() (in module metrolopy.pmethod)</a>
 </li>
       <li><a href="metrolopy.html#metrolopy.pmethod.coverage_probability">coverage_probability() (in module metrolopy.pmethod)</a>
@@ -661,10 +677,12 @@ <h2 id="I">I</h2>
 </li>
       <li><a href="metrolopy.html#metrolopy.exceptions.IncompatibleUnitsError">IncompatibleUnitsError</a>
 </li>
-      <li><a href="metrolopy.html#metrolopy.gummy.gummy.independant">independant (metrolopy.gummy.gummy property)</a>
-</li>
-      <li><a href="metrolopy.html#metrolopy.nummy.nummy.independent">independent (metrolopy.nummy.nummy property)</a>
+      <li><a href="metrolopy.html#metrolopy.gummy.gummy.independent">independent (metrolopy.gummy.gummy property)</a>
+
+      <ul>
+        <li><a href="metrolopy.html#metrolopy.nummy.nummy.independent">(metrolopy.nummy.nummy property)</a>
 </li>
+      </ul></li>
       <li><a href="metrolopy.html#metrolopy.unit.Unit.is_dimensionless">is_dimensionless (metrolopy.unit.Unit property)</a>
 </li>
       <li><a href="metrolopy.html#metrolopy.distributions.Convolution.isindependent">isindependent (metrolopy.distributions.Convolution attribute)</a>
@@ -1938,7 +1956,7 @@ <h2 id="Z">Z</h2>
   <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="search.html" method="get">
-      <input type="text" name="q" aria-labelledby="searchlabel" />
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
     </form>
     </div>
@@ -1957,13 +1975,13 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">metrolopy 0.6.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">metrolopy 0.6.3 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Index</a></li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">
         &#169; Copyright 2020, National Research Council Canada.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.0.2.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 4.5.0.
     </div>
   </body>
 </html>