Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@newville
newville committed Aug 2, 2024
1 parent 98987fb commit 7f61fe2
Show file tree
Hide file tree
Showing 11 changed files with 49 additions and 48 deletions.
2 changes: 1 addition & 1 deletion _static/documentation_options.js
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '1.0.1',
VERSION: '1.0.2',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
7 changes: 4 additions & 3 deletions _static/searchtools.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ const Search = {

htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
for (const removalQuery of [".headerlinks", "script", "style"]) {
for (const removalQuery of [".headerlink", "script", "style"]) {
htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
}
if (anchor) {
Expand Down Expand Up @@ -328,13 +328,14 @@ 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) {
let score = Math.round(100 * queryLower.length / title.length)
const score = Math.round(Scorer.title * queryLower.length / title.length);
const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
normalResults.push([
docNames[file],
titles[file] !== title ? `${titles[file]} > ${title}` : title,
id !== null ? "#" + id : "",
null,
score,
score + boost,
filenames[file],
]);
}
Expand Down
10 changes: 5 additions & 5 deletions api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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=292eb321"></script>
<script src="_static/documentation_options.js?v=1ed6394b"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/bizstyle.js"></script>
Expand All @@ -23,7 +23,7 @@
<script src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -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 navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Table of Contents</a></h3>
Expand Down Expand Up @@ -564,7 +564,7 @@ <h3 id="searchlabel">Quick search</h3>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand All @@ -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.3.7.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.6.
</div>
</body>
</html>
10 changes: 5 additions & 5 deletions basics.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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=292eb321"></script>
<script src="_static/documentation_options.js?v=1ed6394b"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/bizstyle.js"></script>
Expand All @@ -23,7 +23,7 @@
<script src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -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 navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Table of Contents</a></h3>
Expand Down Expand Up @@ -278,7 +278,7 @@ <h3 id="searchlabel">Quick search</h3>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand All @@ -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.3.7.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.6.
</div>
</body>
</html>
10 changes: 5 additions & 5 deletions genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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=292eb321"></script>
<script src="_static/documentation_options.js?v=1ed6394b"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/bizstyle.js"></script>
Expand All @@ -20,7 +20,7 @@
<script src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -134,7 +134,7 @@ <h2 id="V">V</h2>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
Expand All @@ -150,7 +150,7 @@ <h3 id="searchlabel">Quick search</h3>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand All @@ -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.3.7.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.6.
</div>
</body>
</html>
12 changes: 6 additions & 6 deletions index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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=292eb321"></script>
<script src="_static/documentation_options.js?v=1ed6394b"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/bizstyle.js"></script>
Expand All @@ -22,7 +22,7 @@
<script src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -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 navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper"><h3>Contents</h3>

<ul>
Expand All @@ -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.1</b></p>
<p>Current version: <b>1.0.2</b></p>
<p>Install: <tt>pip install asteval</tt></p>
<p>Develop:
&nbsp; <a href="https://github.com/lmfit/asteval/">github.com</a>
Expand Down Expand Up @@ -182,7 +182,7 @@ <h3 id="searchlabel">Quick search</h3>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand All @@ -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.3.7.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.6.
</div>
</body>
</html>
14 changes: 7 additions & 7 deletions installation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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=292eb321"></script>
<script src="_static/documentation_options.js?v=1ed6394b"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/bizstyle.js"></script>
Expand All @@ -23,7 +23,7 @@
<script src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -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.1, which
<p>Asteval is a pure Python module. The latest stable version is 1.0.2, 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
Expand All @@ -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.1 and is available at
<p>The latest stable version of <cite>asteval</cite> is 1.0.2 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>
Expand Down Expand Up @@ -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 navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Table of Contents</a></h3>
Expand Down Expand Up @@ -176,7 +176,7 @@ <h3 id="searchlabel">Quick search</h3>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand All @@ -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.3.7.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.6.
</div>
</body>
</html>
10 changes: 5 additions & 5 deletions motivation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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=292eb321"></script>
<script src="_static/documentation_options.js?v=1ed6394b"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/bizstyle.js"></script>
Expand All @@ -22,7 +22,7 @@
<script src="_static/css3-mediaqueries.js"></script>
<![endif]-->
</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -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 navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<div>
<h3><a href="index.html">Table of Contents</a></h3>
Expand Down Expand Up @@ -274,7 +274,7 @@ <h3 id="searchlabel">Quick search</h3>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand All @@ -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.3.7.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.6.
</div>
</body>
</html>
10 changes: 5 additions & 5 deletions py-modindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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=292eb321"></script>
<script src="_static/documentation_options.js?v=1ed6394b"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/bizstyle.js"></script>
Expand All @@ -27,7 +27,7 @@


</head><body>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand Down Expand Up @@ -69,7 +69,7 @@ <h1>Python Module Index</h1>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
Expand All @@ -85,7 +85,7 @@ <h3 id="searchlabel">Quick search</h3>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
Expand All @@ -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.3.7.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.4.6.
</div>
</body>
</html>
Loading

0 comments on commit 7f61fe2

Please sign in to comment.