update doc

lmfit · Aug 14, 2024 · f8eb052 · f8eb052
1 parent 7f61fe2
commit f8eb052
Show file tree

Hide file tree

Showing 14 changed files with 50 additions and 51 deletions.
diff --git a/_sources/motivation.rst.txt b/_sources/motivation.rst.txt
@@ -102,7 +102,7 @@ In 2024, an independent security audit of asteval done by Andrew Effenhauser,
 Ayman Hammad, and Daniel Crowley in the X-Force Security Research division of
 IBM showed insecurities with ``string.format``, so that access to this and
 ``string.format_map`` method were removed.  In addition, this audit showed
-thatZ the ``numpy`` submodules ``linalg``, ``fft``, and ``polynomial`` expose
+that the ``numpy`` submodules ``linalg``, ``fft``, and ``polynomial`` expose
 many exploitable objects, so these submodules were removed by default.  If
 needed, these modules can be added to any Interpreter either using the
 ``user_symbols`` argument when creating it, or adding the needed symbols to the

diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '1.0.2',
+    VERSION: '1.0.2.post1',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/_static/searchtools.js b/_static/searchtools.js
@@ -178,7 +178,7 @@ const Search = {
 
   htmlToText: (htmlString, anchor) => {
     const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
-    for (const removalQuery of [".headerlink", "script", "style"]) {
+    for (const removalQuery of [".headerlinks", "script", "style"]) {
       htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
     }
     if (anchor) {
@@ -328,14 +328,13 @@ const Search = {
     for (const [title, foundTitles] of Object.entries(allTitles)) {
       if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
         for (const [file, id] of foundTitles) {
-          const score = Math.round(Scorer.title * queryLower.length / title.length);
-          const boost = titles[file] === title ? 1 : 0;  // add a boost for document titles
+          let score = Math.round(100 * queryLower.length / title.length)
           normalResults.push([
             docNames[file],
             titles[file] !== title ? `${titles[file]} > ${title}` : title,
             id !== null ? "#" + id : "",
             null,
-            score + boost,
+            score,
             filenames[file],
           ]);
         }

diff --git a/api.html b/api.html
@@ -10,7 +10,7 @@
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=658d757c" />
 
-    <script src="_static/documentation_options.js?v=1ed6394b"></script>
+    <script src="_static/documentation_options.js?v=d5b3ed16"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/bizstyle.js"></script>
@@ -23,7 +23,7 @@
     <script src="_static/css3-mediaqueries.js"></script>
     <![endif]-->
   </head><body>
-    <div class="related" role="navigation" aria-label="Related">
+    <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -500,7 +500,7 @@ <h2>Utility Functions<a class="headerlink" href="#utility-functions" title="Link
           </div>
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
   <div>
     <h3><a href="index.html">Table of Contents</a></h3>
@@ -564,7 +564,7 @@ <h3 id="searchlabel">Quick search</h3>
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="related" role="navigation" aria-label="Related">
+    <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -585,7 +585,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Matthew Newville, The University of Chicago.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.6.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
     </div>
   </body>
 </html>
diff --git a/asteval.pdf b/asteval.pdf
diff --git a/asteval_doc.zip b/asteval_doc.zip
diff --git a/basics.html b/basics.html
@@ -10,7 +10,7 @@
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=658d757c" />
 
-    <script src="_static/documentation_options.js?v=1ed6394b"></script>
+    <script src="_static/documentation_options.js?v=d5b3ed16"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/bizstyle.js"></script>
@@ -23,7 +23,7 @@
     <script src="_static/css3-mediaqueries.js"></script>
     <![endif]-->
   </head><body>
-    <div class="related" role="navigation" aria-label="Related">
+    <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -228,7 +228,7 @@ <h2>exceptions<a class="headerlink" href="#exceptions" title="Link to this headi
           </div>
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
   <div>
     <h3><a href="index.html">Table of Contents</a></h3>
@@ -278,7 +278,7 @@ <h3 id="searchlabel">Quick search</h3>
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="related" role="navigation" aria-label="Related">
+    <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -299,7 +299,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Matthew Newville, The University of Chicago.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.6.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
     </div>
   </body>
 </html>
diff --git a/genindex.html b/genindex.html
@@ -9,7 +9,7 @@
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=658d757c" />
 
-    <script src="_static/documentation_options.js?v=1ed6394b"></script>
+    <script src="_static/documentation_options.js?v=d5b3ed16"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/bizstyle.js"></script>
@@ -20,7 +20,7 @@
     <script src="_static/css3-mediaqueries.js"></script>
     <![endif]-->
   </head><body>
-    <div class="related" role="navigation" aria-label="Related">
+    <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -134,7 +134,7 @@ <h2 id="V">V</h2>
           </div>
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
 <search id="searchbox" style="display: none" role="search">
   <h3 id="searchlabel">Quick search</h3>
@@ -150,7 +150,7 @@ <h3 id="searchlabel">Quick search</h3>
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="related" role="navigation" aria-label="Related">
+    <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -165,7 +165,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Matthew Newville, The University of Chicago.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.6.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
     </div>
   </body>
 </html>
diff --git a/index.html b/index.html
@@ -10,7 +10,7 @@
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=658d757c" />
 
-    <script src="_static/documentation_options.js?v=1ed6394b"></script>
+    <script src="_static/documentation_options.js?v=d5b3ed16"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/bizstyle.js"></script>
@@ -22,7 +22,7 @@
     <script src="_static/css3-mediaqueries.js"></script>
     <![endif]-->
   </head><body>
-    <div class="related" role="navigation" aria-label="Related">
+    <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -143,7 +143,7 @@ <h1>ASTEVAL: Minimal Python AST Evaluator<a class="headerlink" href="#asteval-mi
           </div>
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper"><h3>Contents</h3>
 
 <ul>
@@ -154,7 +154,7 @@ <h1>ASTEVAL: Minimal Python AST Evaluator<a class="headerlink" href="#asteval-mi
 </ul>
 
 <h3>Get Asteval</h3>
-<p>Current version: <b>1.0.2</b></p>
+<p>Current version: <b>1.0.2.post1</b></p>
 <p>Install:   <tt>pip install asteval</tt></p>
 <p>Develop:
   &nbsp; <a href="https://github.com/lmfit/asteval/">github.com</a>
@@ -182,7 +182,7 @@ <h3 id="searchlabel">Quick search</h3>
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="related" role="navigation" aria-label="Related">
+    <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -200,7 +200,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Matthew Newville, The University of Chicago.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.6.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
     </div>
   </body>
 </html>
diff --git a/installation.html b/installation.html
@@ -10,7 +10,7 @@
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=658d757c" />
 
-    <script src="_static/documentation_options.js?v=1ed6394b"></script>
+    <script src="_static/documentation_options.js?v=d5b3ed16"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/bizstyle.js"></script>
@@ -23,7 +23,7 @@
     <script src="_static/css3-mediaqueries.js"></script>
     <![endif]-->
   </head><body>
-    <div class="related" role="navigation" aria-label="Related">
+    <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -52,7 +52,7 @@ <h3>Navigation</h3>
 <h1>Installing Asteval<a class="headerlink" href="#installing-asteval" title="Link to this heading">¶</a></h1>
 <section id="requirements">
 <h2>Requirements<a class="headerlink" href="#requirements" title="Link to this heading">¶</a></h2>
-<p>Asteval is a pure Python module. The latest stable version is 1.0.2, which
+<p>Asteval is a pure Python module. The latest stable version is 1.0.2.post1, which
 supports Python 3.8 through 3.12.</p>
 <p>Installing <cite>asteval</cite> requires <cite>setuptools</cite> and <cite>setuptools_scm</cite>. No other
 libraries outside of the standard library are required.  If <a class="reference external" href="https://numpy.org/">numpy</a> and
@@ -73,7 +73,7 @@ <h2>Requirements<a class="headerlink" href="#requirements" title="Link to this h
 </section>
 <section id="installing-with-pip">
 <h2>Installing with <cite>pip</cite><a class="headerlink" href="#installing-with-pip" title="Link to this heading">¶</a></h2>
-<p>The latest stable version of <cite>asteval</cite> is 1.0.2 and is available at
+<p>The latest stable version of <cite>asteval</cite> is 1.0.2.post1 and is available at
 <a class="reference external" href="https://pypi.org/project/asteval/">PyPI</a> or as a conda package.  You should be able to install <cite>asteval</cite>
 with:</p>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">asteval</span>
@@ -130,7 +130,7 @@ <h2>License<a class="headerlink" href="#license" title="Link to this heading">¶
           </div>
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
   <div>
     <h3><a href="index.html">Table of Contents</a></h3>
@@ -176,7 +176,7 @@ <h3 id="searchlabel">Quick search</h3>
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="related" role="navigation" aria-label="Related">
+    <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -197,7 +197,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Matthew Newville, The University of Chicago.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.6.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
     </div>
   </body>
 </html>
diff --git a/motivation.html b/motivation.html
@@ -10,7 +10,7 @@
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=658d757c" />
 
-    <script src="_static/documentation_options.js?v=1ed6394b"></script>
+    <script src="_static/documentation_options.js?v=d5b3ed16"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/bizstyle.js"></script>
@@ -22,7 +22,7 @@
     <script src="_static/css3-mediaqueries.js"></script>
     <![endif]-->
   </head><body>
-    <div class="related" role="navigation" aria-label="Related">
+    <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -138,7 +138,7 @@ <h2>How Safe is asteval?<a class="headerlink" href="#how-safe-is-asteval" title=
 Ayman Hammad, and Daniel Crowley in the X-Force Security Research division of
 IBM showed insecurities with <code class="docutils literal notranslate"><span class="pre">string.format</span></code>, so that access to this and
 <code class="docutils literal notranslate"><span class="pre">string.format_map</span></code> method were removed.  In addition, this audit showed
-thatZ the <code class="docutils literal notranslate"><span class="pre">numpy</span></code> submodules <code class="docutils literal notranslate"><span class="pre">linalg</span></code>, <code class="docutils literal notranslate"><span class="pre">fft</span></code>, and <code class="docutils literal notranslate"><span class="pre">polynomial</span></code> expose
+that the <code class="docutils literal notranslate"><span class="pre">numpy</span></code> submodules <code class="docutils literal notranslate"><span class="pre">linalg</span></code>, <code class="docutils literal notranslate"><span class="pre">fft</span></code>, and <code class="docutils literal notranslate"><span class="pre">polynomial</span></code> expose
 many exploitable objects, so these submodules were removed by default.  If
 needed, these modules can be added to any Interpreter either using the
 <code class="docutils literal notranslate"><span class="pre">user_symbols</span></code> argument when creating it, or adding the needed symbols to the
@@ -236,7 +236,7 @@ <h2>How Safe is asteval?<a class="headerlink" href="#how-safe-is-asteval" title=
           </div>
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
   <div>
     <h3><a href="index.html">Table of Contents</a></h3>
@@ -274,7 +274,7 @@ <h3 id="searchlabel">Quick search</h3>
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="related" role="navigation" aria-label="Related">
+    <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -292,7 +292,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Matthew Newville, The University of Chicago.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.6.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
     </div>
   </body>
 </html>
diff --git a/py-modindex.html b/py-modindex.html
@@ -9,7 +9,7 @@
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
     <link rel="stylesheet" type="text/css" href="_static/bizstyle.css?v=658d757c" />
 
-    <script src="_static/documentation_options.js?v=1ed6394b"></script>
+    <script src="_static/documentation_options.js?v=d5b3ed16"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/bizstyle.js"></script>
@@ -27,7 +27,7 @@
 
 
   </head><body>
-    <div class="related" role="navigation" aria-label="Related">
+    <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -69,7 +69,7 @@ <h1>Python Module Index</h1>
           </div>
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="Main">
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
 <search id="searchbox" style="display: none" role="search">
   <h3 id="searchlabel">Quick search</h3>
@@ -85,7 +85,7 @@ <h3 id="searchlabel">Quick search</h3>
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="related" role="navigation" aria-label="Related">
+    <div class="related" role="navigation" aria-label="related navigation">
       <h3>Navigation</h3>
       <ul>
         <li class="right" style="margin-right: 10px">
@@ -100,7 +100,7 @@ <h3>Navigation</h3>
     </div>
     <div class="footer" role="contentinfo">
     &#169; Copyright 2024, Matthew Newville, The University of Chicago.
-      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.6.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
     </div>
   </body>
 </html>