Merge pull request #150 from voetberg/gh-pages-action

Move documentation from readthedocs to Github Pages, bump package versions

Author: bnord

.github/workflows/build-docs.yml

@@ -0,0 +1,54 @@
+name: documentation
+
+on:
+  schedule:
+      - cron: "0 5 * * 1,3,5" # At 5:00am on Monday, Wednesday, and Friday
+  push:
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install poetry
+        run: pipx install poetry
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+          cache: 'poetry'
+      - run: poetry install
+        
+      - name: Install Sphinx-Build 
+        run: |
+          sudo apt install python3-sphinx
+
+      - name: Build Documentation
+        run: |
+          cd docs/
+          poetry run make html
+        
+      - name: Upload Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          name: github-pages
+          path: docs/_build/html/
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    # Specify runner + deployment step
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/make_pdf.yml

@@ -14,7 +14,7 @@ jobs:
           # This should be the path to the paper within your repo.
           paper-path: paper/paper.md
       - name: Upload
-        uses: actions/upload-artifact@v1
+        uses: actions/upload-artifact@v4
         with:
           name: paper
           # This is the output path where Pandoc will write the compiled

.github/workflows/test-bench.yml

@@ -7,28 +7,15 @@ jobs:
   test:
 
     runs-on: ubuntu-latest
-
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python 3.10
-      uses: actions/setup-python@v2
-      with:
-        python-version: "3.10"
-    - name: Install poetry ${{ matrix.poetry-version }}
-      env:
-        ACTIONS_ALLOW_UNSECURE_COMMANDS: 'true'
-      run: |
-        python -m ensurepip
-        python -m pip install --upgrade pip
-        python -m pip install poetry==1.3.2
-
-    - name: View poetry --help
-      run: poetry --help
-
-    - name: Install dependencies
-      shell: bash
-      run: python -m poetry install
-
-    - name: Test with pytest
-      run: |
-       python3 -m poetry run pytest --cov
+      - uses: actions/checkout@v4
+      - name: Install poetry
+        run: pipx install poetry
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+          cache: 'poetry'
+      - run: poetry install
+
+      - name: Test with pytest
+        run: poetry run pytest --cov

README.md

@@ -1,7 +1,7 @@
 ![GitHub Workflow Status](https://github.com/deepskies/DeepBench/actions/workflows/test-bench.yml/badge.svg?label=test)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 [![PyPI version](https://badge.fury.io/py/deepbench.svg)](https://badge.fury.io/py/deepbench)
-[![Documentation Status](https://readthedocs.org/projects/deepbench/badge/?version=latest)](https://deepbench.readthedocs.io/en/latest/?badge=latest)
+[![documentation](https://github.com/deepskies/DeepBench/actions/workflows/build-docs.yml/badge.svg)](https://github.com/deepskies/DeepBench/actions/workflows/build-docs.yml)
 [![status](https://joss.theoj.org/papers/300762982613649881f8b6a08dabd33e/status.svg)](https://joss.theoj.org/papers/300762982613649881f8b6a08dabd33e)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.14845251.svg)](https://doi.org/10.5281/zenodo.14845251)
 
@@ -16,7 +16,7 @@ Simulation library for very simple simulations to *benchmark* machine learning a
 
 ## Documentation
 
-#### [ReadTheDocs](https://deepbench.readthedocs.io/en/latest/)
+#### [Docs Page](https://deepskies.github.io/DeepBench/)
 
 #### To build from source
 ```
@@ -28,14 +28,14 @@ make html
 The folder `docs/_build/html` will be populated with the documentation. Navigate to `file:///<Path To DeepBench>/docs/_build/html/index.html` in any web browser to view.
 
 ## Requirements
-* python = ">=3.8,<3.11,"
-* numpy = "^1.24.3"
-* matplotlib = "^3.7.1"
-* scikit-image = "^0.20.0"
-* astropy = "^5.2.2"
-* autograd = "^1.5"
-* pyyaml = "^6.0"
-
+python = ">=3.12,<4.0,"
+numpy = ">=1.25.0"
+matplotlib = ">=3.7.1"
+scikit-image = "^0.23.0"
+astropy = ">=7.0.0"
+autograd = ">=1.5"
+pyyaml = ">=6.0"
+h5py = ">=3.9.0"
 
 
 ## Install
@@ -50,7 +50,6 @@ pip install deepbench
 ```
 git clone https://github.com/deepskies/DeepBench.git
 pip install poetry
-poetry shell
 poetry install
 poetry run pytest --cov
 ```