Merge pull request #21 from mathysgrapotte/documentation

Fixing docs not building
mathysgrapotte · Nov 22, 2024 · 2daaa3e · 2daaa3e
2 parents 0748037 + f3e9df6
commit 2daaa3e
Show file tree

Hide file tree

Showing 12 changed files with 47 additions and 8 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -0,0 +1,36 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - documentation
+      - dev  # or your default branch name
+  workflow_dispatch:  # Allows manual triggering
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # fetch all history for proper versioning
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-dependency-glob: pyproject.toml
+
+      - name: Install dependencies
+        run: make setup
+
+      - name: Deploy documentation
+        run: make docs-deploy 
diff --git a/README.md b/README.md
@@ -2,8 +2,10 @@
 
 [![ci](https://github.com/mathysgrapotte/stimulus-py/workflows/ci/badge.svg)](https://github.com/mathysgrapotte/stimulus-py/actions?query=workflow%3Aci)
 [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mathysgrapotte.github.io/stimulus-py/)
-[![pypi version](https://img.shields.io/pypi/v/stimulus-py.svg)](https://pypi.org/project/stimulus-py/)
 [![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#stimulus-py:gitter.im)
+[![Build with us on slack!](http://img.shields.io/badge/slack-nf--core%20%23deepmodeloptim-4A154B?labelColor=000000&logo=slack)](https://nfcore.slack.com/channels/deepmodeloptim)
+
+<!-- [![pypi version](https://img.shields.io/pypi/v/stimulus-py.svg)](https://pypi.org/project/stimulus-py/) -->
 
 ## Introduction
 
@@ -15,8 +17,10 @@ Here, we attempt at solving the testing problem by proposing an extensive librar
 
 ## Installation
 
+stimulus is still under development, you can install it from test-pypi by running the following command:
+
 ```bash
-pip install stimulus-py
+pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple stimulus-py==0.0.10
 ```
 
 
diff --git a/duties.py b/duties.py
@@ -120,10 +120,14 @@ def docs(ctx: Context, *cli_args: str, host: str = "127.0.0.1", port: int = 8000
 def docs_deploy(ctx: Context) -> None:
     """Deploy the documentation to GitHub pages."""
     os.environ["DEPLOY"] = "true"
+    """
     with material_insiders() as insiders:
         if not insiders:
             ctx.run(lambda: False, title="Not deploying docs without Material for MkDocs Insiders!")
         ctx.run(tools.mkdocs.gh_deploy(), title="Deploying documentation")
+    """
+    # commented part above because we do not have access to the Material for MkDocs Insiders (this is a paid feature)
+    ctx.run(tools.mkdocs.gh_deploy(), title="Deploying documentation")
 
 
 @duty

diff --git a/pyproject.toml b/pyproject.toml
@@ -35,7 +35,7 @@ dependencies = [
     "multiprocess==0.70.17",
     "numpy>=1.26.0,<2.0.0",
     "pandas>=2.2.0",
-    "polars-lts-cpu>=0.20.30",
+    "polars-lts-cpu>=0.20.30,<1.12.0",
     "ray[default,train,tune]>=2.23.0; python_version < '3.12'",
     "ray[default,train,tune]>=2.38.0; python_version >= '3.12'",
     "safetensors>=0.4.5",

diff --git a/src/__init__.py → src/stimulus/analysis/__init__.py b/src/__init__.py → src/stimulus/analysis/__init__.py
diff --git a/src/stimulus/cli/__init__.py b/src/stimulus/cli/__init__.py
diff --git a/src/stimulus/data/encoding/__init__.py b/src/stimulus/data/encoding/__init__.py
diff --git a/src/stimulus/data/splitters/__init__.py b/src/stimulus/data/splitters/__init__.py
diff --git a/src/stimulus/data/transform/__init__.py b/src/stimulus/data/transform/__init__.py
diff --git a/src/stimulus/learner/__init__.py b/src/stimulus/learner/__init__.py
diff --git a/src/stimulus/utils/__init__.py b/src/stimulus/utils/__init__.py