Skip to content

Merge pull request #9 from TheBrambleShark/MkDocs #4

Merge pull request #9 from TheBrambleShark/MkDocs

Merge pull request #9 from TheBrambleShark/MkDocs #4

Workflow file for this run

name: Build MK Docs
on:
push:
branches:
- main
env:
MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }}
permissions:
contents: write
pages: write
jobs:
build:
name: Build Docs
runs-on: ubuntu-latest
steps:
- name: Checkout master
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.x
- run: pip install -r requirements.txt
- run: mkdocs gh-deploy --force
deploy:
name: Deploy Docs
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
ref: gh-pages
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: '.'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4