Skip to content

Build and Deploy Documentation #217

Build and Deploy Documentation

Build and Deploy Documentation #217

Workflow file for this run

name: Build and Deploy Documentation
on:
push:
branches:
- main
schedule:
- cron: '0 0 * * *' # run nightly at midnight
# Allows manual workflow from Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: write
pages: write
id-token: write
pull-requests: write
# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: 3.x
cache: 'pip'
- name: Install python dependencies
run: pip install -r docs/requirements.txt
- name: Setup Pages
id: pages
uses: actions/configure-pages@v2
- name: Build with mkdocs
run: |
cd docs
mkdocs build -c
- name: Deploy
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: ./docs/site
clean: true
# clean-exclude: pr-preview/
target-folder: main
force: false