Skip to content

Commit

Permalink
Test publishing Sphinx docs using GitHub Pages
Browse files Browse the repository at this point in the history
  • Loading branch information
Janne Pulkkinen committed Sep 10, 2024
1 parent bc2a4dd commit 2558c54
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: documentation

on: [push, pull_request]

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
# Ubuntu 20.04 has Python 3.9
runs-on: ubuntu-20.04

steps:
- uses: actions/checkout@v2
- name: Set up Python 3.9
uses: actions/setup-python@v2
with:
python-version: "3.9"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
python -m pip -r requirements_github.txt
python -m pip install sphinx sphinx-autodoc-typehints
- name: Run Sphinx build
run: make doc
- name: Upload doc artifacts
uses: actions/upload-pages-artifact@v3
with:
path: ./doc/build/html

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 2558c54

Please sign in to comment.