Skip to content

Deploy docs

Deploy docs #286

Workflow file for this run

name: Deploy docs
on:
push:
paths: ['docs/**', '*.md']
pull_request:
paths: ['docs/**', '*.md']
branches: [master]
schedule:
- cron: '0 6 * * 6'
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Download source
uses: actions/checkout@v4
- name: Install Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install dependencies
run: pip install --no-deps -r requirements/requirements-docs.txt
- name: Fetch branch
run: git fetch origin v1:v1
- name: Build site
run: mkdocs build -f docs/mkdocs.yml --strict
- name: Upload to GitHub Pages
uses: actions/upload-pages-artifact@v3
with:
path: site
deploy:
if: github.event_name == 'push' && github.ref_name == github.event.repository.default_branch
needs: build
permissions:
pages: write
id-token: write
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}