Skip to content

Commit

Permalink
Create docs-gh-pages.yml
Browse files Browse the repository at this point in the history
  • Loading branch information
johannes-mueller authored Jan 9, 2024
1 parent c92ff57 commit 11acee9
Showing 1 changed file with 52 additions and 0 deletions.
52 changes: 52 additions & 0 deletions .github/workflows/docs-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: documentation

on:
workflow_dispatch:
push:
branches: [ master ]
pull_request:
branches: [ master ]

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: 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-documentation:
runs-on: [self-hosted, ubuntu-latest]
container: python:3-buster
steps:
- uses: actions/checkout@v3
- name: Install dependencies
run: |
apt-get update
apt-get -y install xvfb pandoc
python -m pip install --upgrade pip setuptools setuptools_scm wheel
pip install -e .[docs]
pip install -r docs/requirements.txt
- name: Build documentation
run: |
sphinx-build -b html docs/ _site
- name: Upload artifact
uses: actions/upload-pages-artifact@v3

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4

0 comments on commit 11acee9

Please sign in to comment.