Prepare for version 0.3.0 (#84)

* Prepare for version 0.3.0

* Fixes

* Update changelog

---------

Signed-off-by: LouisCarpentier42 <louis.carpentier@kuleuven.be>

Author: LouisCarpentier42

.github/workflows/check-changelog-updated.yml

@@ -0,0 +1,27 @@
+name: Changelog updated
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  check-changelog:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Fetch main branch
+      run: git fetch origin main
+
+    - name: Check if changelog is updated
+      run: |
+        if git diff --name-only origin/main ${{ github.sha }} | grep -q 'docs/additional_information/changelog.rst'; then
+          echo "Changelog has been updated."
+        else
+          echo "::error::Changelog has not been updated."
+          exit 1
+        fi

.github/workflows/check-print-statements.yml

@@ -0,0 +1,26 @@
+name: Print statements
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  check-print-statements:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Check for print statements in source code
+      run: |
+        print_files=$(grep -rnw --include="*.py" dtaianomaly -e 'print(' || true)
+        if [ -n "$print_files" ]; then
+          echo "::error::Print statements found in the following files and lines:"
+          echo "$print_files"
+          exit 1
+        else
+          echo "No print statements found."
+        fi

.github/workflows/unit-tests.yml

@@ -11,11 +11,12 @@ on:
 
 jobs:
   unit-test:
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
 
     strategy:
       fail-fast: false
       matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
         python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:

.readthedocs.yaml

@@ -14,11 +14,14 @@ build:
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
   configuration: docs/conf.py
+  fail_on_warning: true
 
 # Optional but recommended, declare the Python requirements required
 # to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
-   install:
-   - requirements: requirements.txt
-   - requirements: requirements-dev.txt
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs

README.md

@@ -5,11 +5,16 @@
 <h1 align="center">dtaianomaly</h1>
 <h2 align="center">Time series anomaly detection</h2>
 
-[![Documentation Status](https://readthedocs.org/projects/dtaianomaly/badge/?version=stable)](https://dtaianomaly.readthedocs.io/en/stable/?badge=stable)
+[![Unit tests](https://github.com/ML-KULeuven/dtaianomaly/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/ML-KULeuven/dtaianomaly/actions/workflows/unit-tests.yml)
+[![Doctest](https://github.com/ML-KULeuven/dtaianomaly/actions/workflows/doctest.yml/badge.svg)](https://github.com/ML-KULeuven/dtaianomaly/actions/workflows/doctest.yml)
+[![docs-stable](https://img.shields.io/readthedocs/aeon-toolkit/latest?logo=readthedocs&label=docs%20%28stable%29)](https://dtaianomaly.readthedocs.io/en/stable)
+[![docs-latest](https://img.shields.io/readthedocs/aeon-toolkit/latest?logo=readthedocs&label=docs%20%28latest%29)](https://dtaianomaly.readthedocs.io/en/latest)
 [![PyPi Version](https://img.shields.io/pypi/v/dtaianomaly.svg)](https://pypi.org/project/dtaianomaly/)
 [![Downloads](https://static.pepy.tech/badge/dtaianomaly)](https://pepy.tech/project/dtaianomaly)
 [![PyPI pyversions](https://img.shields.io/pypi/pyversions/dtaianomaly)](https://pypi.python.org/pypi/dtaianomaly/)
 [![PyPI license](https://img.shields.io/pypi/l/dtaianomaly.svg)](https://pypi.python.org/pypi/dtaianomaly/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
 
 A simple-to-use Python package for the development and analysis of time series anomaly 
 detection techniques. Here we describe the main usage of `dtaianomaly`, but be sure to

docs/additional_information/changelog.rst

@@ -4,8 +4,8 @@ Changelog
 All notable changes to this project will be documented in this file.
 
 
-Latest
-------
+[0.3.0] - 2025-01-31
+--------------------
 
 Added
 ^^^^^

docs/conf.py

@@ -72,6 +72,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
+os.makedirs("_static", exist_ok=True)  # Ensure the _static directory exists
 html_static_path = ['_static']
 
 # -- Options for HTMLHelp output ------------------------------------------

docs/getting_started/examples.rst

@@ -54,7 +54,7 @@ to implement an anomaly detector), after which the component can be used is if i
 is natively a part of ``dtaianomaly``.
 
 .. seealso::
-    Check out the :doc:`custom model example<examples/custom_models>` for more information!
+    Check out the :doc:`extensibility example<examples/extensibility>` for more information!
 
 
 .. rubric:: Quantitative evaluation with a workflow

…tting_started/examples/custom_models.rst …tting_started/examples/extensibility.rstdocs/getting_started/examples/custom_models.rst renamed to docs/getting_started/examples/extensibility.rst docs/getting_started/examples/custom_models.rst renamed to docs/getting_started/examples/extensibility.rst

@@ -1,6 +1,6 @@
 :orphan:
 
-Custom models
+Extensibility
 =============
 
 Even though ``dtaianomaly`` already offers a lot of functionality, there is always room

dtaianomaly/__init__.py

@@ -1 +1 @@
-__version__ = "0.2.3.dev"
+__version__ = "0.3.0"