Skip to content

Commit

Permalink
ci: added basic docs build & publish workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
ErikBjare committed Oct 27, 2023
1 parent 36792fc commit 9e1efd2
Showing 1 changed file with 59 additions and 0 deletions.
59 changes: 59 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Docs

on:
push:
branches:
- master
pull_request:
branches:
- master

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v2

- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: '3.x'

- name: Install dependencies
run: |
python -m pip install --upgrade poetry
poetry install
- name: Build docs
run: make docs

- name: Upload artifact
uses: actions/upload-artifact@v2
with:
name: documentation
path: ./docs/_build

deploy:
name: deploy
runs-on: ubuntu-latest
needs: [build]
if: github.ref == 'refs/heads/master'

steps:
- name: Checkout
uses: actions/checkout@v2

- name: Download artifact
uses: actions/download-artifact@v2
with:
name: documentation
path: ./docs/_build

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
publish_dir: ./docs/_build
publish_branch: gh-pages
destination_dir: docs

0 comments on commit 9e1efd2

Please sign in to comment.