Skip to content

Deploy GitHub Pages with mkdocs #28

Deploy GitHub Pages with mkdocs

Deploy GitHub Pages with mkdocs #28

Workflow file for this run

name: Deploy GitHub Pages with mkdocs
on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]
# Allows you 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: 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:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.x
- name: Install doc dependencies
run: |
pip install -r requirements-docs.txt
- name: Install django dependencies
run: |
pip install -r requirements.txt
- name: Build and deploy documentation
run: mkdocs gh-deploy --force