Skip to content

Update to github actions #2

Update to github actions

Update to github actions #2

Workflow file for this run

name: Deploy MkDocs Site
on:
push:
branches:
- master # Change this to your default branch if it's not master.
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Setup Python
uses: actions/setup-python@v4
with:
python-version: '3.10' # Ensure this matches the Python version you use locally.
- name: Install Requirements
run: |
python -m pip install --upgrade pip
pip install -r requirements-doc.txt # This file should list mkdocs and any other packages.
- name: Build and deploy MkDocs
run: |
mkdocs build --verbose # Build the site.
mkdocs gh-deploy --force --verbose # Deploy the site to the gh-pages branch.
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Use the provided GITHUB_TOKEN for authentication.