Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v0.1.9 #42

Merged
merged 2 commits into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7a843bd555ee874c00dbc710835f6133
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7b2edb81324a2cee77846b2cbbcd2de8
tags: 645f666f9bcd5a90fca523b33c5a78b7
14 changes: 7 additions & 7 deletions docs/build/html/_modules/antropy/entropy.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>antropy.entropy &#8212; antropy 0.1.8 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<title>antropy.entropy &#8212; antropy 0.1.9 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b76e3c8a" />
<link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css?v=9f61996d" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../../_static/style.css?v=917eae1c" />
<script src="../../_static/documentation_options.js?v=22607128"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/documentation_options.js?v=8618f531"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../_static/copybutton.js?v=fd10adb8"></script>
Expand Down Expand Up @@ -39,7 +39,7 @@
</button>
<a class="navbar-brand" href="../../index.html">
antropy</a>
<span class="navbar-text navbar-version pull-left"><b>0.1.8</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.1.9</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down Expand Up @@ -1154,8 +1154,8 @@ <h1>Source code for antropy.entropy</h1><div class="highlight"><pre>

</p>
<p>
&copy; Copyright 2018-2024, Raphael Vallat.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br/>
&copy; Copyright 2018-2025, Raphael Vallat.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
</p>
</div>
</footer>
Expand Down
14 changes: 7 additions & 7 deletions docs/build/html/_modules/antropy/fractal.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>antropy.fractal &#8212; antropy 0.1.8 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<title>antropy.fractal &#8212; antropy 0.1.9 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=b76e3c8a" />
<link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css?v=9f61996d" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../../_static/style.css?v=917eae1c" />
<script src="../../_static/documentation_options.js?v=22607128"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/documentation_options.js?v=8618f531"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../../_static/copybutton.js?v=fd10adb8"></script>
Expand Down Expand Up @@ -39,7 +39,7 @@
</button>
<a class="navbar-brand" href="../../index.html">
antropy</a>
<span class="navbar-text navbar-version pull-left"><b>0.1.8</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.1.9</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down Expand Up @@ -558,8 +558,8 @@ <h1>Source code for antropy.fractal</h1><div class="highlight"><pre>

</p>
<p>
&copy; Copyright 2018-2024, Raphael Vallat.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br/>
&copy; Copyright 2018-2025, Raphael Vallat.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
</p>
</div>
</footer>
Expand Down
14 changes: 7 additions & 7 deletions docs/build/html/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; antropy 0.1.8 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<title>Overview: module code &#8212; antropy 0.1.9 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
<link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css?v=9f61996d" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/style.css?v=917eae1c" />
<script src="../_static/documentation_options.js?v=22607128"></script>
<script src="../_static/doctools.js?v=9bcbadda"></script>
<script src="../_static/documentation_options.js?v=8618f531"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=fd10adb8"></script>
Expand Down Expand Up @@ -39,7 +39,7 @@
</button>
<a class="navbar-brand" href="../index.html">
antropy</a>
<span class="navbar-text navbar-version pull-left"><b>0.1.8</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.1.9</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down Expand Up @@ -97,8 +97,8 @@ <h1>All modules for which code is available</h1>

</p>
<p>
&copy; Copyright 2018-2024, Raphael Vallat.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br/>
&copy; Copyright 2018-2025, Raphael Vallat.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
</p>
</div>
</footer>
Expand Down
5 changes: 5 additions & 0 deletions docs/build/html/_sources/changelog.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
What's new
##########

v0.1.9 (February 2025)
----------------------

- Remove `stochastic` package from dependency to enable support for Numpy 2.x

v0.1.8 (December 2024)
----------------------

Expand Down
15 changes: 13 additions & 2 deletions docs/build/html/_static/basic.css
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
/*
* basic.css
* ~~~~~~~~~
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/

/* -- main layout ----------------------------------------------------------- */
Expand Down Expand Up @@ -108,11 +115,15 @@ img {
/* -- search page ----------------------------------------------------------- */

ul.search {
margin-top: 10px;
margin: 10px 0 0 20px;
padding: 0;
}

ul.search li {
padding: 5px 0;
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
}

ul.search li a {
Expand Down
7 changes: 7 additions & 0 deletions docs/build/html/_static/doctools.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
/*
* doctools.js
* ~~~~~~~~~~~
*
* Base JavaScript utilities for all Sphinx HTML documentation.
*
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
"use strict";

Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '0.1.8',
VERSION: '0.1.9',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
7 changes: 7 additions & 0 deletions docs/build/html/_static/language_data.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
/*
* language_data.js
* ~~~~~~~~~~~~~~~~
*
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/

var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
Expand Down
1 change: 0 additions & 1 deletion docs/build/html/_static/pygments.css
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
Expand Down
45 changes: 16 additions & 29 deletions docs/build/html/_static/searchtools.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
/*
* searchtools.js
* ~~~~~~~~~~~~~~~~
*
* Sphinx JavaScript utilities for the full-text search.
*
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
"use strict";

Expand All @@ -13,7 +20,7 @@ if (typeof Scorer === "undefined") {
// and returns the new score.
/*
score: result => {
const [docname, title, anchor, descr, score, filename, kind] = result
const [docname, title, anchor, descr, score, filename] = result
return score
},
*/
Expand All @@ -40,14 +47,6 @@ if (typeof Scorer === "undefined") {
};
}

// Global search result kind enum, used by themes to style search results.
class SearchResultKind {
static get index() { return "index"; }
static get object() { return "object"; }
static get text() { return "text"; }
static get title() { return "title"; }
}

const _removeChildren = (element) => {
while (element && element.lastChild) element.removeChild(element.lastChild);
};
Expand All @@ -65,13 +64,9 @@ const _displayItem = (item, searchTerms, highlightTerms) => {
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
const contentRoot = document.documentElement.dataset.content_root;

const [docName, title, anchor, descr, score, _filename, kind] = item;
const [docName, title, anchor, descr, score, _filename] = item;

let listItem = document.createElement("li");
// Add a class representing the item's type:
// can be used by a theme's CSS selector for styling
// See SearchResultKind for the class names.
listItem.classList.add(`kind-${kind}`);
let requestUrl;
let linkUrl;
if (docBuilder === "dirhtml") {
Expand Down Expand Up @@ -120,10 +115,8 @@ const _finishSearch = (resultCount) => {
"Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
);
else
Search.status.innerText = Documentation.ngettext(
"Search finished, found one page matching the search query.",
"Search finished, found ${resultCount} pages matching the search query.",
resultCount,
Search.status.innerText = _(
"Search finished, found ${resultCount} page(s) matching the search query."
).replace('${resultCount}', resultCount);
};
const _displayNextItem = (
Expand All @@ -145,7 +138,7 @@ const _displayNextItem = (
else _finishSearch(resultCount);
};
// Helper function used by query() to order search results.
// Each input is an array of [docname, title, anchor, descr, score, filename, kind].
// Each input is an array of [docname, title, anchor, descr, score, filename].
// Order the results by score (in opposite order of appearance, since the
// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
const _orderResultsByScoreThenName = (a, b) => {
Expand Down Expand Up @@ -185,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) {
Expand Down Expand Up @@ -255,7 +248,6 @@ const Search = {
searchSummary.classList.add("search-summary");
searchSummary.innerText = "";
const searchList = document.createElement("ul");
searchList.setAttribute("role", "list");
searchList.classList.add("search");

const out = document.getElementById("search-results");
Expand Down Expand Up @@ -326,7 +318,7 @@ const Search = {
const indexEntries = Search._index.indexentries;

// Collect multiple result groups to be sorted separately and then ordered.
// Each is an array of [docname, title, anchor, descr, score, filename, kind].
// Each is an array of [docname, title, anchor, descr, score, filename].
const normalResults = [];
const nonMainIndexResults = [];

Expand All @@ -336,16 +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) {
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],
SearchResultKind.title,
]);
}
}
Expand All @@ -363,7 +353,6 @@ const Search = {
null,
score,
filenames[file],
SearchResultKind.index,
];
if (isMain) {
normalResults.push(result);
Expand Down Expand Up @@ -485,7 +474,6 @@ const Search = {
descr,
score,
filenames[match[0]],
SearchResultKind.object,
]);
};
Object.keys(objects).forEach((prefix) =>
Expand Down Expand Up @@ -596,7 +584,6 @@ const Search = {
null,
score,
filenames[file],
SearchResultKind.text,
]);
}
return results;
Expand Down
16 changes: 8 additions & 8 deletions docs/build/html/api.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />

<title>API reference &#8212; antropy 0.1.8 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<title>API reference &#8212; antropy 0.1.9 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b76e3c8a" />
<link rel="stylesheet" type="text/css" href="_static/bootstrap-sphinx.css?v=9f61996d" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/style.css?v=917eae1c" />
<script src="_static/documentation_options.js?v=22607128"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/documentation_options.js?v=8618f531"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=fd10adb8"></script>
Expand Down Expand Up @@ -41,7 +41,7 @@
</button>
<a class="navbar-brand" href="index.html">
antropy</a>
<span class="navbar-text navbar-version pull-left"><b>0.1.8</b></span>
<span class="navbar-text navbar-version pull-left"><b>0.1.9</b></span>
</div>

<div class="collapse navbar-collapse nav-collapse">
Expand Down Expand Up @@ -149,8 +149,8 @@ <h2>Fractal dimension<a class="headerlink" href="#fractal-dimension" title="Link

</p>
<p>
&copy; Copyright 2018-2024, Raphael Vallat.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br/>
&copy; Copyright 2018-2025, Raphael Vallat.<br/>
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.3.7.<br/>
</p>
</div>
</footer>
Expand Down
Loading