Add github action for python package and doc

lens-biophotonics · Jan 6, 2021 · 8a0494a · 8a0494a
1 parent 7072668
commit 8a0494a
Show file tree

Hide file tree

Showing 5 changed files with 54 additions and 0 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -13,3 +13,6 @@ trim_trailing_whitespace = false
 
 [Makefile]
 indent_style = tab
+
+[*.yml]
+indent_size = 2
diff --git a/.github/workflows/python-package-and-doc.yml b/.github/workflows/python-package-and-doc.yml
@@ -0,0 +1,49 @@
+name: Python package and documentation
+
+on:
+  push:
+    branches: [master]
+  workflow_dispatch:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    - uses: actions/cache@v2
+      with:
+        path: ${{ env.pythonLocation }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('./requirements.txt', './requirements-dev.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    - uses: actions/cache@v2
+      with:
+        path: ~/.local
+        key: ${{ runner.os }}-pip-${{ hashFiles('./requirements.txt', './requirements-dev.txt') }}
+        restore-keys: |
+          ${{ runner.os }}-pip-
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements.txt -r requirements-dev.txt
+    - name: Test
+      run: make test
+    - name: Build wheel
+      run: make
+    - name: sphinx
+      working-directory: ./doc
+      env:
+        PYTHONPATH: ..
+      run: make html
+    - name: GitHub Pages
+      uses: crazy-max/ghaction-github-pages@v2.2.0
+      with:
+        build_dir: doc/_build/html
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/requirements.dev.in → requirements-dev.in b/requirements.dev.in → requirements-dev.in
@@ -3,3 +3,4 @@ numpydoc
 pip-tools
 sphinx
 sphinx_rtd_theme
+wheel
diff --git a/requirements.dev.txt → requirements-dev.txt b/requirements.dev.txt → requirements-dev.txt
@@ -34,6 +34,7 @@ sphinxcontrib-jsmath==1.0.1  # via sphinx
 sphinxcontrib-qthelp==1.0.3  # via sphinx
 sphinxcontrib-serializinghtml==1.1.4  # via sphinx
 urllib3==1.26.2           # via requests
+wheel==0.36.1             # via -r requirements.dev.in
 
 # The following packages are considered to be unsafe in a requirements file:
 # pip

diff --git a/tests/__init__.py b/tests/__init__.py
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,3 +3,4 @@ numpydoc @@
     pip-tools
     sphinx
     sphinx_rtd_theme
+    wheel