Skip to content

ci: docs deployment should now work - cleaned up #97

ci: docs deployment should now work - cleaned up

ci: docs deployment should now work - cleaned up #97

Workflow file for this run

# Sample workflow for building and deploying a Jekyll site to GitHub Pages
name: Docs
on:
# Runs on pushes targeting the default branch
push:
branches:
- '*'
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: write
pages: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: 3.12
- name: Requirements
run: |
sudo apt-get install -y python3-sphinx
pip install .[docs]
- name: Build
run: |
python setup.py build_ext --inplace
cd docs
make clean
rm source/code/*
bash autodoc.sh
make html
cd build/html
touch .nojekyll
shell: bash
# Deployment job
- name: deploy
uses: JamesIves/github-pages-deploy-action@releases/v4
with:
branch: gh-pages # The branch the action should deploy to.
folder: docs/build/html # The folder the action should deploy.
if: github.ref_name == 'main' # Only deploy on pushes to the main branch