feat(docs): add rerun diagram for readme (#30)

* docs(documentation): add documentation link to README in toml * docs(example-notebook): rerun the example notebook * docs(README): refine examples and add more images * docs(pkg-version): update pkg version on the badge --------- Co-authored-by: N. L <nino@pleno.earth>
Aeternalis-Ingenium · Dec 11, 2023 · 06bb49f · 06bb49f
1 parent f9c4ad4
commit 06bb49f
Show file tree

Hide file tree

Showing 11 changed files with 715 additions and 552 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/assets/DetectionResult.png b/docs/assets/DetectionResult.png
diff --git a/docs/assets/Exceedances.png b/docs/assets/Exceedances.png
diff --git a/docs/assets/PDFGPD.png b/docs/assets/PDFGPD.png
diff --git a/docs/assets/PeaksOverThreshold.png b/docs/assets/PeaksOverThreshold.png
diff --git a/docs/assets/QQPlot-GPD.png b/docs/assets/QQPlot-GPD.png
diff --git a/docs/assets/QQPlot.png b/docs/assets/QQPlot.png
diff --git a/docs/example.ipynb b/docs/example.ipynb
diff --git a/pyproject.toml b/pyproject.toml
@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 name = "anomalytics"
 description = "The ultimate anomaly detection library."
 readme = "README.md"
-version = "0.1.5"
+version = "0.1.6"
 license = {file = "LICENSE"}
 requires-python = ">=3.10"
 authors = [
@@ -47,6 +47,7 @@ dependencies = [
 
 [project.urls]
 repository = "https://github.com/Aeternalis-Ingenium/anomalytics"
+documentation = "https://github.com/Aeternalis-Ingenium/anomalytics/blob/trunk/README.md"
 
 [project.optional-dependencies]
 codequality = [

diff --git a/src/anomalytics/__init__.py b/src/anomalytics/__init__.py
@@ -1,4 +1,4 @@
-__version__ = "0.1.5"
+__version__ = "0.1.6"
 
 __all__ = [
  "get_anomaly",

diff --git a/tests/test_version.py b/tests/test_version.py
@@ -2,4 +2,4 @@
 
 
 def test_pkg_version():
- assert __version__ == "0.1.5"
+ assert __version__ == "0.1.6"