Skip to content

Publish Docs

Publish Docs #11

Workflow file for this run

name: Publish documentation website
on:
workflow_dispatch:
push:
branches:
- main
paths:
- "docs/**"
- "mkdocs.yml"
permissions:
id-token: write
pages: write
contents: write
jobs:
build-docs:
name: Build documentation
runs-on: ubuntu-latest
steps:
- name: Checkout the code
uses: actions/checkout@v4
- name: Install Python
uses: actions/setup-python@v5
with:
python-version: 3.x
- name: Install dependencies
run: pip install mkdocs-material
- name: Publish the documentation
run: |
mkdocs gh-deploy --force --message "cd: deploy docs from {sha}"
publish-docs:
name: Publish documentation
runs-on: ubuntu-latest
needs: build-docs
steps:
- name: Checkout
uses: actions/checkout@v4
with:
ref: gh-pages
- name: Setup pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: "."
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4