Deploy docs #47
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
# This is a basic workflow to help you get started with Actions | |
name: Deploy docs | |
# Controls when the workflow will run | |
on: | |
# push: | |
# branches: [ "master" ] | |
# | |
workflow_dispatch: | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-python@v4 | |
with: | |
python-version: '3.11' | |
- name: Update pip | |
run: python -m pip install -U pip | |
- name: Get docs requirements | |
run: python -m pip install -r doc/requirements.txt | |
- name: Install the package | |
run: python -m pip install . | |
- name: Build docs | |
run: sphinx-build doc/ doc/_build/html | |
- uses: actions/upload-pages-artifact@v2 | |
with: | |
path: doc/_build/html | |
deploy: | |
runs-on: ubuntu-latest | |
needs: build | |
permissions: | |
pages: write | |
id-token: write | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- uses: actions/deploy-pages@v2 |