Skip to content

Deploy documentation to Github Pages #9

Deploy documentation to Github Pages

Deploy documentation to Github Pages #9

Workflow file for this run

name: Deploy documentation to Github Pages
on:
workflow_dispatch:
permissions: write-all
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Set up Python 3.10
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx furo
- name: Build website
run: |
sphinx-build -M dirhtml docs docs/_build
- name: Fix permissions
run: |
chmod -c -R +rX "docs/_build/dirhtml/" | while read line; do
echo "::warning title=Invalid file permissions automatically fixed::$line"
done
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs/_build/dirhtml'
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