Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 39 additions & 23 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,62 @@ name: Update Documentation

on:
workflow_dispatch:

push:
branches:
- master

permissions:
contents: read

concurrency:
group: pages
cancel-in-progress: true

jobs:
documentation:
build:
name: Build documentation
runs-on: ubuntu-latest
name: Documentation

strategy:
fail-fast: false
matrix:
python-version:
[
'3.10'
]

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

- name: Setup Python ${{ matrix.python-version }}
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python-version }}
cache: 'pip'
python-version: "3.10"
cache: pip

- name: Install tools
run: make build

- name: Clean
run: make dev

- name: Generate Documentation
- name: Generate documentation
run: make docs

- name: Push
uses: s0/git-publish-subdir-action@develop
env:
REPO: self
BRANCH: gh-pages
FOLDER: doc/_build/html
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
MESSAGE: "Documentation updated"
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v4
with:
name: github-pages
path: doc/_build/html

deploy:
name: Deploy documentation
needs: build
runs-on: ubuntu-latest

permissions:
pages: write
id-token: write

environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
Loading