Skip to content

docs: publish documentation to github pages 🥳 #3

docs: publish documentation to github pages 🥳

docs: publish documentation to github pages 🥳 #3

Workflow file for this run

name: Build and publish documentation
on:
push:
branches:
- main
tags: [v*]
pull_request:
paths:
- "docs/**"
- ".mkdocs.yaml"
concurrency:
group: "${{ github.workflow }}-${{ github.ref }}"
cancel-in-progress: true
permissions:
contents: write
jobs:
build_documentation:
if: ${{ github.event_name == 'pull_request' }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8 # v6
- uses: actions/setup-python@83679a892e2d95755f2dac6acb0bfd1e9ac5d548 # v6
with:
python-version: '3.14'
- name: Install mkdocs
run: pip install mkdocs==1.6.1 # renovate: depName=mkdocs/mkdocs
- name: Build documentation
run: make docs-build
- name: Configure git
run: |
git config --global user.name "GitHub Actions"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
- name: Publish documentation
run: mkdocs gh-deploy --strict -f .mkdocs.yaml