Skip to content

Deploy MkDocs to GitHub Pages #21

Deploy MkDocs to GitHub Pages

Deploy MkDocs to GitHub Pages #21

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: Deploy MkDocs to GitHub Pages
on:
push:
tags:
- 'v*'
# Allows to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Single deploy job since we're just deploying
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: 3.x
- name: Install MkDocs and extensions
run: |
python -m pip install --upgrade pip
pip install mkdocs mkdocs-material "mkdocstrings[python]"
- name: Build MkDocs site
run: mkdocs build
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: './site'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2