Skip to content

Updating pyproject.toml and README #16

Updating pyproject.toml and README

Updating pyproject.toml and README #16

Workflow file for this run

# Sphinx documentation build and push to GitHub pages
name: build-docs
on:
# Triggers the workflow on push or pull request events but only for the "main" branch
push:
branches: [ "main" ]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
jobs:
build:
runs-on: ubuntu-latest
steps:
# Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
- uses: actions/checkout@v3
- name: Install documentation dependencies
run: |
sudo apt install opencl-c-headers ocl-icd-opencl-dev doxygen
sudo pip3 install --upgrade pip setuptools build numpy
pip3 install --user --upgrade -r $GITHUB_WORKSPACE/doc/requirements.txt
python3 -m build --wheel $GITHUB_WORKSPACE
pip3 install --user --upgrade --ignore-installed $GITHUB_WORKSPACE/dist/*.whl
- name: Run the documentation build
run: |
sphinx-build -M html $GITHUB_WORKSPACE/doc $GITHUB_WORKSPACE/build
touch $GITHUB_WORKSPACE/build/html/.nojekyll
- name: JSON endpoint on success
if: ${{ success() }}
run: python -c 'import json; print(json.dumps(dict(schemaVersion=1, label="build-docs", style="for-the-badge", namedLogo="github", message="success", color="green")))' > $GITHUB_WORKSPACE/build/html/endpoint.json
- name: JSON endpoint on failure
if: ${{ failure() }}
run: python -c 'import json; print(json.dumps(dict(schemaVersion=1, label="build-docs", style="for-the-badge", namedLogo="github", message="failure", color="red")))' > $GITHUB_WORKSPACE/build/html/endpoint.json
- name: Push to documentation branch
uses: s0/git-publish-subdir-action@develop
env:
REPO: self
BRANCH: gh-pages # The branch name where you want to push the assets
FOLDER: build/html # The directory where your assets are generated
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # GitHub will automatically add this
MESSAGE: "Build: ({sha}) {msg}" # The commit message