update docs

Author: Žiga Stupan

.readthedocs.yaml

@@ -6,16 +6,17 @@ version: 2
 
 # Set the OS, Python version and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.12"
+    python: "3.13"
 
 sphinx:
   configuration: docs/source/conf.py
   fail_on_warning: true
 
 # Optionally build your docs in additional formats such as PDF and ePub
-formats: all
+formats:
+  - pdf
 
 # Optional but recommended, declare the Python requirements required
 # to build your documentation

CONTRIBUTING.md

@@ -27,53 +27,47 @@ If you are not so familiar with Git or/and GitHub, we suggest you take a look at
 
 ### Requirements
 
-* Python >= 3.10
-* Poetry: https://python-poetry.org/docs/
+* Python >= 3.11
+* uv: https://docs.astral.sh/uv/
 
 ### Development dependencies
 
 **NiaPy dependencies:**
 
-| Package    |  Version  | Platform |
-|------------|:---------:|:--------:|
-| numpy      | ^1.26.1   |   All    |
-| pandas     | ^2.1.1    |   All    |
-| openpyxl   | ^3.1.2    |   All    |
-| matplotlib | ^3.8.0    |   All    |
+| Package    | Version  | Platform |
+|------------|:--------:|:--------:|
+| numpy      | \>=2.3.5 |   All    |
+| pandas     | \>=2.3.3 |   All    |
+| openpyxl   | >=3.1.5  |   All    |
+| matplotlib | >=3.10.8 |   All    |
 
-**Test dependencies:**
+**Development dependencies:**
 
-| Package         |  Version         | Platform |
-|-----------------|:----------------:|:--------:|
-| pytest          | >=7.4.2,<9.0.0   |   Any    |
-| pytest-cov      | ^4.1.0           |   Any    |
-| pytest-randomly | ^3.15.0          |   Any    |
+| Package         | Version  | Platform |
+|-----------------|:--------:|:--------:|
+| pytest          | \>=9.0.0 |   All    |
+| pytest-cov      | \>=7.0.0 |   All    |
+| pytest-randomly | \>=4.0.1 |   All    |
 
 **Documentation dependencies (optional):**
 
-| Package            | Version  | Platform |
-|--------------------|:--------:|:--------:|
-| sphinx             | ^7.2.6   |   Any    |
-| sphinx-rtd-theme   | ^1.3.0   |   Any    |
+| Package          | Version  | Platform |
+|------------------|:--------:|:--------:|
+| sphinx           | \>=8.2.3 |   All    |
+| sphinx-rtd-theme | \>=3.0.2 |   All    |
 
 ### Installation
 
 Install project dependencies into a virtual environment:
 
 ```sh
-$ poetry install
+uv sync
 ```
 
 Install the optional documentation dependencies with:
 
 ```sh
-$ poetry install --with docs
-```
-
-To enter created virtual environment with all installed dependencies run:
-
-```sh
-$ poetry shell
+uv sync --group docs
 ```
 
 ## Development Tasks
@@ -83,17 +77,15 @@ $ poetry shell
 Run the tests:
 
 ```sh
-$ poetry run pytest
+uv run pytest
 ```
 
 ### Documentation
 
 Build the documentation:
 
 ```sh
-$ poetry shell
-$ cd docs
-$ make html
+uv run sphinx-build ./docs ./docs/_build
 ```
 
 ## Support

README.md

@@ -70,7 +70,7 @@ Nature-inspired algorithms are a very popular tool for solving optimization prob
 
 * **Free software:** MIT license
 * **Documentation:** https://niapy.readthedocs.io/en/stable
-* **Python versions:** 3.10.x, 3.11.x, 3.12.x, 3.13.x, 3.14.x
+* **Python versions:** 3.11.x, 3.12.x, 3.13.x, 3.14.x
 * **Dependencies:** listed in [CONTRIBUTING.md](CONTRIBUTING.md#development-dependencies)
 
 ## 🎯 Mission

docs/requirements.txt

@@ -1,100 +1,113 @@
-#
-# This file is autogenerated by pip-compile with Python 3.11
-# by the following command:
-#
-#    pip-compile requirements.in
-#
-alabaster==0.7.13
+# This file was autogenerated by uv via the following command:
+#    uv pip compile pyproject.toml --group dev --group docs
+alabaster==1.0.0
     # via sphinx
-babel==2.13.1
+babel==2.17.0
     # via sphinx
-certifi==2023.7.22
+certifi==2025.11.12
     # via requests
-charset-normalizer==3.3.1
+charset-normalizer==3.4.4
     # via requests
-contourpy==1.2.0
+contourpy==1.3.3
     # via matplotlib
+coverage==7.13.0
+    # via pytest-cov
 cycler==0.12.1
     # via matplotlib
-docutils==0.18.1
+docutils==0.21.2
     # via
     #   sphinx
     #   sphinx-rtd-theme
-et-xmlfile==1.1.0
+et-xmlfile==2.0.0
     # via openpyxl
-fonttools==4.51.0
+fonttools==4.61.0
     # via matplotlib
-idna==3.4
+idna==3.11
     # via requests
 imagesize==1.4.1
     # via sphinx
-jinja2==3.1.3
+iniconfig==2.3.0
+    # via pytest
+jinja2==3.1.6
     # via sphinx
-kiwisolver==1.4.5
+kiwisolver==1.4.9
     # via matplotlib
-markupsafe==2.1.3
+markupsafe==3.0.3
     # via jinja2
-matplotlib==3.8.2
-    # via -r requirements.in
-numpy==1.26.4
+matplotlib==3.10.8
+    # via niapy (pyproject.toml)
+numpy==2.3.5
     # via
-    #   -r requirements.in
+    #   niapy (pyproject.toml)
     #   contourpy
     #   matplotlib
     #   pandas
-openpyxl==3.1.2
-    # via -r requirements.in
-packaging==23.2
+openpyxl==3.1.5
+    # via niapy (pyproject.toml)
+packaging==25.0
     # via
     #   matplotlib
+    #   pytest
     #   sphinx
-pandas==2.2.1
-    # via -r requirements.in
-pillow==10.2.0
+pandas==2.3.3
+    # via niapy (pyproject.toml)
+pillow==12.0.0
     # via matplotlib
-pygments==2.16.1
-    # via sphinx
-pyparsing==3.1.1
+pluggy==1.6.0
+    # via
+    #   pytest
+    #   pytest-cov
+pygments==2.19.2
+    # via
+    #   pytest
+    #   sphinx
+pyparsing==3.2.5
     # via matplotlib
-python-dateutil==2.8.2
+pytest==9.0.2
+    # via
+    #   niapy (pyproject.toml:dev)
+    #   pytest-cov
+    #   pytest-randomly
+pytest-cov==7.0.0
+    # via niapy (pyproject.toml:dev)
+pytest-randomly==4.0.1
+    # via niapy (pyproject.toml:dev)
+python-dateutil==2.9.0.post0
     # via
     #   matplotlib
     #   pandas
-pytz==2024.1
+pytz==2025.2
     # via pandas
-requests==2.31.0
+requests==2.32.5
+    # via sphinx
+roman-numerals-py==3.1.0
     # via sphinx
-six==1.16.0
+six==1.17.0
     # via python-dateutil
-snowballstemmer==2.2.0
+snowballstemmer==3.0.1
     # via sphinx
-sphinx==7.2.6
+sphinx==8.2.3
     # via
-    #   -r requirements.in
+    #   niapy (pyproject.toml:docs)
     #   sphinx-rtd-theme
-    #   sphinxcontrib-applehelp
-    #   sphinxcontrib-devhelp
-    #   sphinxcontrib-htmlhelp
     #   sphinxcontrib-jquery
-    #   sphinxcontrib-qthelp
-    #   sphinxcontrib-serializinghtml
-sphinx-rtd-theme==1.3.0
-    # via -r requirements.in
-sphinxcontrib-applehelp==1.0.7
+sphinx-rtd-theme==3.0.2
+    # via niapy (pyproject.toml:docs)
+sphinxcontrib-applehelp==2.0.0
     # via sphinx
-sphinxcontrib-devhelp==1.0.5
+sphinxcontrib-devhelp==2.0.0
     # via sphinx
-sphinxcontrib-htmlhelp==2.0.4
+sphinxcontrib-htmlhelp==2.1.0
     # via sphinx
 sphinxcontrib-jquery==4.1
     # via sphinx-rtd-theme
 sphinxcontrib-jsmath==1.0.1
     # via sphinx
-sphinxcontrib-qthelp==1.0.6
+sphinxcontrib-qthelp==2.0.0
     # via sphinx
-sphinxcontrib-serializinghtml==1.1.9
+sphinxcontrib-serializinghtml==2.0.0
     # via sphinx
-tzdata==2023.4
+tzdata==2025.2
     # via pandas
-urllib3==2.0.7
+urllib3==2.6.2
     # via requests

docs/source/conf.py

@@ -92,7 +92,6 @@
 #
 html_theme_options = {
     "logo_only": True,
-    "display_version": False,
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

docs/source/documentation.rst

@@ -10,6 +10,6 @@ To locally generate the documentation run the following command in the project r
 
 .. code-block:: bash
 
-    poetry run sphinx-build docs/source docs/build/html
+    uv run sphinx-build docs/source docs/_build
 
-You can then view it by opening docs/build/html/index.html in your browser
+You can then view it by opening docs/_build/index.html in your browser

docs/source/index.rst

@@ -23,7 +23,7 @@ implementing algorithms from scratch.
 
 * **Free software:** MIT license
 * **Github repository:** https://github.com/NiaOrg/NiaPy
-* **Python versions:** 3.10.x, 3.11.x, 3.12.x, 3.13.x, 3.14.x
+* **Python versions:** 3.11.x, 3.12.x, 3.13.x, 3.14.x
 
 The main documentation is organized into a couple sections:
 

docs/source/installation.rst

@@ -7,8 +7,8 @@ Setup development environment
 Requirements
 ~~~~~~~~~~~~
 
-- Python: `download <https://www.python.org/downloads/>`__ (3.10 or greater)
-- Poetry: `docs <https://python-poetry.org/docs/>`__
+- Python: `download <https://www.python.org/downloads/>`__ (3.11 or greater)
+- uv: `docs <https://docs.astral.sh/uv/>`__
 
 
 Installation of development dependencies
@@ -18,22 +18,16 @@ Install project dependencies into a virtual environment:
 
 .. code-block:: bash
 
-    poetry install
+    uv sync
 
 Install documentation dependencies with:
 
 .. code-block:: bash
 
-    poetry install --with docs
+    uv sync --group docs
 
 Run tests with:
 
 .. code-block:: bash
 
-    poetry run pytest
-
-To enter created virtual environment with all installed development dependencies run:
-
-.. code-block:: bash
-
-    poetry shell
+    uv run pytest

docs/source/testing.rst

@@ -16,7 +16,7 @@ For the purpose of checking if all test are passing locally you can run followin
 
 .. code-block:: bash
 
-    poetry run pytest
+    uv run pytest
 
 If all tests passed running this command it is most likely that the tests would pass on
-our build system to.
+our build system too.