Merge pull request #117 from Ab2nour/master

ci: fix broken doc build & update GitHub Actions versions

Author: arokem

.github/workflows/docbuild.yml

@@ -13,9 +13,9 @@ jobs:
 
     steps:
     - name: Checkout repo
-      uses: actions/checkout@v1
+      uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
@@ -24,22 +24,19 @@ jobs:
         pip install -r requirements.txt
         pip install -r requirements-dev.txt
         pip install .
-    - name: Install software
-      run: |
-        pip install .
     - name: Build docs
       run: |
         cd docs
         make html
     - name: Upload docs
-      uses: actions/upload-artifact@v1
+      uses: actions/upload-artifact@v4
       with:
         name: docs
         path: docs/_build/html
     - name: Publish docs to Github Pages
       if: startsWith(github.event.ref, 'refs/tags')
-      uses: JamesIves/github-pages-deploy-action@releases/v3
+      uses: JamesIves/github-pages-deploy-action@releases/v4
       with:
-        ACCESS_TOKEN: ${{ secrets.ACCESS_TOKEN }}
-        BRANCH: gh-pages # The branch the action should deploy to.
-        FOLDER: docs/_build/html # The folder the action should deploy.
+        token: ${{ secrets.GITHUB_TOKEN }}
+        branch: gh-pages # The branch the action should deploy to.
+        folder: 'docs/_build/html' # The folder the action should deploy.

.github/workflows/pythonpackage.yml

@@ -12,9 +12,9 @@ jobs:
         python-version: [3.9]
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

docs/conf.py

@@ -39,6 +39,7 @@
     'sphinx.ext.viewcode',
     'numpydoc',
     'sphinx_gallery.gen_gallery',
+    'sphinx.ext.githubpages',
 ]
 
 

docs/index.rst

@@ -16,13 +16,13 @@ To examine and download the source code, visit our `github repo <https://github.
        Random Forests: The Jackknife and the Infinitesimal Jackknife", Journal
        of Machine Learning Research vol. 15, pp. 1625-1651, 2014.
 
-    .. toctree::
-       :maxdepth: 2
+.. toctree::
+   :maxdepth: 2
 
-       installation_guide
-       api
-       auto_examples/index
-       contributing
+   installation_guide
+   api
+   auto_examples/index
+   contributing
 
 .. figure:: _static/eScience_Logo_HR.png
    :align: center