Merge pull request #130 from martius-lab/fkloss/readthedocs #36
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# build docs using sphinx and deploy to branch gh-pages | |
name: Documentation | |
on: | |
push: | |
branches: | |
- master | |
workflow_dispatch: | |
inputs: | |
publish: | |
description: "Publish to GitHub Pages (disable to only test the build)" | |
type: boolean | |
default: false | |
jobs: | |
build_and_deploy: | |
runs-on: ubuntu-latest | |
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment | |
permissions: | |
pages: write # to deploy to Pages | |
id-token: write # to verify the deployment originates from an appropriate source | |
# Deploy to the github-pages environment | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- name: Build and deploy documentation | |
uses: sphinx-notes/pages@v3 | |
with: | |
publish: ${{ github.event_name == 'push' || github.event.inputs.publish == 'true' }} |