Changed release pipeline, added rtd settings.

.github/workflows/publish-to-pypi.yml

@@ -18,14 +18,18 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v4
         with:
-          python-version: "3.x"
+          python-version:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install setuptools wheel
       - name: Build package
         run: |
-          python setup.py sdist bdist_wheel
+          pip install -e .[doc]
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
         with:

.readthedocs.yaml

@@ -0,0 +1,24 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - doc

docs/conf.py

@@ -0,0 +1,46 @@
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
+# -- Project information -----------------------------------------------------
+
+project = 'jaxkan'
+copyright = '2024-2025, Spyros Rigas, Michalis Papachristou'
+author = 'Spyros Rigas, Michalis Papachristou'
+
+# The full version, including alpha/beta/rc tags
+release = '0.1.9'
+
+# -- General configuration ------------------------------------------------
+
+exclude_patterns = []
+
+extensions = [
+    "myst_parser",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.duration",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+    "sphinx_autodoc_typehints",
+    "sphinx_design",
+    "sphinx.ext.mathjax", 
+    "sphinx.ext.coverage",
+    "nbsphinx",
+    "nbsphinx_link"
+]
+
+language = 'en'
+
+templates_path = ['_templates']
+
+# -- Options for HTML output ----------------------------------------------
+
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']