Skip to content

Commit 4f44553

Browse files
raphaelvallatraphaelvallat
committed
update doc to v0.1.8
1 parent 57caf26 commit 4f44553

34 files changed

+205
-165
lines changed

Diff for: ‎README.rst

+9
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,15 @@ or conda
4141
conda config --set channel_priority strict
4242
conda install antropy
4343
44+
To build and install from source, clone this repository or download the source archive and decompress the files
45+
46+
.. code-block:: shell
47+
48+
cd antropy
49+
pip install ".[test]" # install the package
50+
pip install -e ".[test]" # or editable install
51+
pytest
52+
4453
**Dependencies**
4554

4655
- `numpy <https://numpy.org/>`_

Diff for: ‎docs/build/html/.buildinfo

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
2-
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 3a25f3b4fb97564eec51e3b795229bc5
2+
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 7a843bd555ee874c00dbc710835f6133
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

Diff for: ‎docs/build/html/_modules/antropy/entropy.html

+9-8
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44
<head>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>antropy.entropy &#8212; antropy 0.1.7 documentation</title>
7+
<title>antropy.entropy &#8212; antropy 0.1.8 documentation</title>
88
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css?v=9f61996d" />
1010
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
1111
<link rel="stylesheet" type="text/css" href="../../_static/style.css?v=917eae1c" />
12-
<script src="../../_static/documentation_options.js?v=ca7ad2ea"></script>
13-
<script src="../../_static/doctools.js?v=9a2dae69"></script>
12+
<script src="../../_static/documentation_options.js?v=22607128"></script>
13+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
1414
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1515
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
16-
<script src="../../_static/copybutton.js?v=fe0808e4"></script>
16+
<script src="../../_static/copybutton.js?v=fd10adb8"></script>
1717
<link rel="icon" href="../../_static/antropy.ico"/>
1818
<link rel="index" title="Index" href="../../genindex.html" />
1919
<link rel="search" title="Search" href="../../search.html" />
@@ -39,7 +39,7 @@
3939
</button>
4040
<a class="navbar-brand" href="../../index.html">
4141
antropy</a>
42-
<span class="navbar-text navbar-version pull-left"><b>0.1.7</b></span>
42+
<span class="navbar-text navbar-version pull-left"><b>0.1.8</b></span>
4343
</div>
4444

4545
<div class="collapse navbar-collapse nav-collapse">
@@ -81,11 +81,12 @@
8181
<h1>Source code for antropy.entropy</h1><div class="highlight"><pre>
8282
<span></span><span class="sd">&quot;&quot;&quot;Entropy functions&quot;&quot;&quot;</span>
8383

84+
<span class="kn">from</span> <span class="nn">math</span> <span class="kn">import</span> <span class="n">factorial</span><span class="p">,</span> <span class="n">log</span>
85+
8486
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
8587
<span class="kn">from</span> <span class="nn">numba</span> <span class="kn">import</span> <span class="n">jit</span><span class="p">,</span> <span class="n">types</span>
86-
<span class="kn">from</span> <span class="nn">math</span> <span class="kn">import</span> <span class="n">factorial</span><span class="p">,</span> <span class="n">log</span>
87-
<span class="kn">from</span> <span class="nn">sklearn.neighbors</span> <span class="kn">import</span> <span class="n">KDTree</span>
8888
<span class="kn">from</span> <span class="nn">scipy.signal</span> <span class="kn">import</span> <span class="n">periodogram</span><span class="p">,</span> <span class="n">welch</span>
89+
<span class="kn">from</span> <span class="nn">sklearn.neighbors</span> <span class="kn">import</span> <span class="n">KDTree</span>
8990

9091
<span class="kn">from</span> <span class="nn">.utils</span> <span class="kn">import</span> <span class="n">_embed</span><span class="p">,</span> <span class="n">_xlogx</span>
9192

@@ -1154,7 +1155,7 @@ <h1>Source code for antropy.entropy</h1><div class="highlight"><pre>
11541155
</p>
11551156
<p>
11561157
&copy; Copyright 2018-2024, Raphael Vallat.<br/>
1157-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.4.7.<br/>
1158+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br/>
11581159
</p>
11591160
</div>
11601161
</footer>

Diff for: ‎docs/build/html/_modules/antropy/fractal.html

+8-7
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44
<head>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>antropy.fractal &#8212; antropy 0.1.7 documentation</title>
7+
<title>antropy.fractal &#8212; antropy 0.1.8 documentation</title>
88
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="../../_static/bootstrap-sphinx.css?v=9f61996d" />
1010
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
1111
<link rel="stylesheet" type="text/css" href="../../_static/style.css?v=917eae1c" />
12-
<script src="../../_static/documentation_options.js?v=ca7ad2ea"></script>
13-
<script src="../../_static/doctools.js?v=9a2dae69"></script>
12+
<script src="../../_static/documentation_options.js?v=22607128"></script>
13+
<script src="../../_static/doctools.js?v=9bcbadda"></script>
1414
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
1515
<script src="../../_static/clipboard.min.js?v=a7894cd8"></script>
16-
<script src="../../_static/copybutton.js?v=fe0808e4"></script>
16+
<script src="../../_static/copybutton.js?v=fd10adb8"></script>
1717
<link rel="icon" href="../../_static/antropy.ico"/>
1818
<link rel="index" title="Index" href="../../genindex.html" />
1919
<link rel="search" title="Search" href="../../search.html" />
@@ -39,7 +39,7 @@
3939
</button>
4040
<a class="navbar-brand" href="../../index.html">
4141
antropy</a>
42-
<span class="navbar-text navbar-version pull-left"><b>0.1.7</b></span>
42+
<span class="navbar-text navbar-version pull-left"><b>0.1.8</b></span>
4343
</div>
4444

4545
<div class="collapse navbar-collapse nav-collapse">
@@ -81,9 +81,10 @@
8181
<h1>Source code for antropy.fractal</h1><div class="highlight"><pre>
8282
<span></span><span class="sd">&quot;&quot;&quot;Fractal functions&quot;&quot;&quot;</span>
8383

84+
<span class="kn">from</span> <span class="nn">math</span> <span class="kn">import</span> <span class="n">floor</span><span class="p">,</span> <span class="n">log</span>
85+
8486
<span class="kn">import</span> <span class="nn">numpy</span> <span class="k">as</span> <span class="nn">np</span>
8587
<span class="kn">from</span> <span class="nn">numba</span> <span class="kn">import</span> <span class="n">jit</span><span class="p">,</span> <span class="n">types</span>
86-
<span class="kn">from</span> <span class="nn">math</span> <span class="kn">import</span> <span class="n">log</span><span class="p">,</span> <span class="n">floor</span>
8788

8889
<span class="kn">from</span> <span class="nn">.entropy</span> <span class="kn">import</span> <span class="n">num_zerocross</span>
8990
<span class="kn">from</span> <span class="nn">.utils</span> <span class="kn">import</span> <span class="n">_linear_regression</span><span class="p">,</span> <span class="n">_log_n</span>
@@ -558,7 +559,7 @@ <h1>Source code for antropy.fractal</h1><div class="highlight"><pre>
558559
</p>
559560
<p>
560561
&copy; Copyright 2018-2024, Raphael Vallat.<br/>
561-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.4.7.<br/>
562+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br/>
562563
</p>
563564
</div>
564565
</footer>

Diff for: ‎docs/build/html/_modules/index.html

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,16 @@
44
<head>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Overview: module code &#8212; antropy 0.1.7 documentation</title>
7+
<title>Overview: module code &#8212; antropy 0.1.8 documentation</title>
88
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="../_static/bootstrap-sphinx.css?v=9f61996d" />
1010
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
1111
<link rel="stylesheet" type="text/css" href="../_static/style.css?v=917eae1c" />
12-
<script src="../_static/documentation_options.js?v=ca7ad2ea"></script>
13-
<script src="../_static/doctools.js?v=9a2dae69"></script>
12+
<script src="../_static/documentation_options.js?v=22607128"></script>
13+
<script src="../_static/doctools.js?v=9bcbadda"></script>
1414
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
1515
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
16-
<script src="../_static/copybutton.js?v=fe0808e4"></script>
16+
<script src="../_static/copybutton.js?v=fd10adb8"></script>
1717
<link rel="icon" href="../_static/antropy.ico"/>
1818
<link rel="index" title="Index" href="../genindex.html" />
1919
<link rel="search" title="Search" href="../search.html" />
@@ -39,7 +39,7 @@
3939
</button>
4040
<a class="navbar-brand" href="../index.html">
4141
antropy</a>
42-
<span class="navbar-text navbar-version pull-left"><b>0.1.7</b></span>
42+
<span class="navbar-text navbar-version pull-left"><b>0.1.8</b></span>
4343
</div>
4444

4545
<div class="collapse navbar-collapse nav-collapse">
@@ -98,7 +98,7 @@ <h1>All modules for which code is available</h1>
9898
</p>
9999
<p>
100100
&copy; Copyright 2018-2024, Raphael Vallat.<br/>
101-
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 7.4.7.<br/>
101+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 8.1.3.<br/>
102102
</p>
103103
</div>
104104
</footer>

Diff for: ‎docs/build/html/_sources/changelog.rst.txt

+5
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
What's new
44
##########
55

6+
v0.1.8 (December 2024)
7+
----------------------
8+
9+
- Switch to modern python packaging
10+
- Use ruff instead of black/flake8
611

712
v0.1.7 (December 2024)
813
----------------------

Diff for: ‎docs/build/html/_sources/index.rst.txt

+9
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,15 @@ or conda
3636
conda config --set channel_priority strict
3737
conda install antropy
3838
39+
To build and install from source, clone this repository or download the source archive and decompress the files
40+
41+
.. code-block:: shell
42+
43+
cd antropy
44+
pip install ".[test]" # install the package
45+
pip install -e ".[test]" # or editable install
46+
pytest
47+
3948
**Dependencies**
4049

4150
- `numpy <https://numpy.org/>`_

Diff for: ‎docs/build/html/_static/basic.css

+2-13
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
/*
2-
* basic.css
3-
* ~~~~~~~~~
4-
*
52
* Sphinx stylesheet -- basic theme.
6-
*
7-
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
8-
* :license: BSD, see LICENSE for details.
9-
*
103
*/
114

125
/* -- main layout ----------------------------------------------------------- */
@@ -115,15 +108,11 @@ img {
115108
/* -- search page ----------------------------------------------------------- */
116109

117110
ul.search {
118-
margin: 10px 0 0 20px;
119-
padding: 0;
111+
margin-top: 10px;
120112
}
121113

122114
ul.search li {
123-
padding: 5px 0 5px 20px;
124-
background-image: url(file.png);
125-
background-repeat: no-repeat;
126-
background-position: 0 7px;
115+
padding: 5px 0;
127116
}
128117

129118
ul.search li a {

Diff for: ‎docs/build/html/_static/copybutton.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ const messages = {
2020
},
2121
'fr' : {
2222
'copy': 'Copier',
23-
'copy_to_clipboard': 'Copié dans le presse-papier',
23+
'copy_to_clipboard': 'Copier dans le presse-papier',
2424
'copy_success': 'Copié !',
2525
'copy_failure': 'Échec de la copie',
2626
},
@@ -224,7 +224,7 @@ var copyTargetText = (trigger) => {
224224
var target = document.querySelector(trigger.attributes['data-clipboard-target'].value);
225225

226226
// get filtered text
227-
let exclude = '.linenos, .gp';
227+
let exclude = '.linenos';
228228

229229
let text = filterText(target, exclude);
230230
return formatCopyText(text, '>>> |\\.\\.\\. |\\$ ', true, true, true, true, '', '')

Diff for: ‎docs/build/html/_static/doctools.js

-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
/*
2-
* doctools.js
3-
* ~~~~~~~~~~~
4-
*
52
* Base JavaScript utilities for all Sphinx HTML documentation.
6-
*
7-
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
8-
* :license: BSD, see LICENSE for details.
9-
*
103
*/
114
"use strict";
125

Diff for: ‎docs/build/html/_static/documentation_options.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '0.1.7',
2+
VERSION: '0.1.8',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

Diff for: ‎docs/build/html/_static/language_data.js

-7
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
/*
2-
* language_data.js
3-
* ~~~~~~~~~~~~~~~~
4-
*
52
* This script contains the language-specific data used by searchtools.js,
63
* namely the list of stopwords, stemmer, scorer and splitter.
7-
*
8-
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
9-
* :license: BSD, see LICENSE for details.
10-
*
114
*/
125

136
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"];

0 commit comments

Comments
 (0)