moving docs generation from travis-ci to github actions

Author: denisri

.github/workflows/main.yml

@@ -0,0 +1,57 @@
+# This is a basic workflow to help you get started with Actions
+
+name: CI
+
+# Controls when the workflow will run
+on:
+  # Triggers the workflow on push or pull request events but only for the master branch
+  push:
+    branches: [ master ]
+#   pull_request:
+#     branches: [ master ]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  doc:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.10
+
+      - name: "Install Python dependencies"
+        run: |
+          pip3 install setuptools
+          pip3 install numpy 'six>=1.13' 'argparse'
+          # for docs only
+          sudo apt-get install -y pandoc graphviz
+          pip install sphinx sphinx-gallery pandoc nbsphinx
+          # python setup.py install
+
+      - name: "Build Sphinx Doc"
+        run: |
+          export PYTHONPATH=$PWD/python
+          cd doc
+          python -m sphinx -b html source build/html
+          touch build/html/.nojekyll
+          cd ..
+
+      # 3. Déploiement sur les Github Pages
+
+      - name: "Deploy Github Pages"
+        uses: JamesIves/[email protected]
+        with:
+          # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages     # <- Branche sur laquelle seront commités les fichiers
+          FOLDER: doc/build/html/  # <- Dossier contenant notre documentation générée

.travis.yml

@@ -2,24 +2,11 @@ sudo: false
 
 matrix:
   include:
-    - os: osx
-      language: generic
-      name: python 3.7
     - os: linux
       language: python
-      name: python 2.7
+      name: python 3.10
       python:
-        - 2.7
-    - os: linux
-      language: python
-      name: python 3.5
-      python:
-        - 3.5
-    - os: linux
-      language: python
-      name: python 3.7
-      python:
-        - 3.7
+        - 3.10
 
 before_install:
     - echo "TRAVIS_PYTHON_VERSION:" "$TRAVIS_PYTHON_VERSION"
@@ -32,18 +19,13 @@ before_install:
     #- if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then export PATH="/usr/local/opt/[email protected]/bin:$PATH"; ln -s `which python3` bin/python; ln -s `which pip3` bin/pip; export PATH="$PWD/bin:$PATH"; fi
     - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then ln -s `which python3` bin/python; ln -s `which pip3` bin/pip; export PATH="$PWD/bin:$PATH"; fi
     - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then python --version; fi
-    - if [[ "$TRAVIS_OS_NAME" == "linux" && "$TRAVIS_PYTHON_VERSION" == "3.5" ]]; then sudo apt-get install -y pandoc graphviz; pip install sphinx sphinx-gallery pandoc nbsphinx "PyQt5<5.13"; fi
 
 install:
     - pip install "six~=1.13" paramiko zmq
-    - if [ ${TRAVIS_PYTHON_VERSION} == "2.7" ]; then pip install subprocess32; fi
     - pip install codecov
     - python setup.py install
     - export QT_API=pyqt5
     - if [[ $TRAVIS_OS_NAME == linux ]]; then pip install pre-commit; fi
-    # build doc; set .nojekyll otherwise github.io doesn't copy dirs starting
-    # with '_' (such as '_static')
-    - if [[  "$TRAVIS_OS_NAME" = "linux" && "$TRAVIS_PYTHON_VERSION" == "3.5" ]]; then cd doc && make html && touch build/html/.nojekyll && cd ..; fi
     - if [[ -n "$GITHUB_ACCESS_TOKEN" ]]; then export PUSH_DOC_TO_GH_PAGES=yes; fi
     - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then cat /proc/cpuinfo && free; fi
 
@@ -57,17 +39,6 @@ script:
 after_success:
     - codecov
 
-deploy:
-  provider: pages
-  skip_cleanup: true
-  github_token: $GITHUB_ACCESS_TOKEN
-  target-branch: gh-pages
-  local-dir: doc/build/html
-  on:
-    branch: master
-    condition: $PUSH_DOC_TO_GH_PAGES == yes && $TRAVIS_OS_NAME == linux && $TRAVIS_PYTHON_VERSION == 3.5
-
-
 cache:
   directories:
     - $HOME/.cache/pre-commit