Skip to content

merge: Restructure Docs (#18) #37

merge: Restructure Docs (#18)

merge: Restructure Docs (#18) #37

Workflow file for this run

name: Deploy to GitHub Pages
on:
workflow_dispatch:
push:
branches: [master]
paths:
- .github/workflows/deploy.yml
- docs/**
- mkdocs.yml
- requirements.txt
permissions:
actions: read
contents: read
pages: write
id-token: write
concurrency:
group: github-pages
cancel-in-progress: false
jobs:
buildAndDeploy:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deploy.outputs.page_url }} # Used to report back the URL of the deploy.
steps:
- name: Checkout Repository
uses: actions/checkout@v4
with:
fetch-depth: 0 # Required for git-revision-date-localized plugin
- name: Setup Python 3.x
uses: actions/setup-python@v5
with:
python-version: '3.x'
- name: Install Dependencies
run: |
pip install -U pip setuptools
pip install -r requirements.txt
- name: Build Pages
run: mkdocs build
env:
GIT_COMMITTER_ENABLED: true # Used to enable Git Committers plugin
COMMITTER_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Used to increase rate limits for GitHub API.
- name: Configure GitHub Pages
uses: actions/configure-pages@v5
- name: Upload Pages Artifact
uses: actions/upload-pages-artifact@v3
with:
path: site/
- name: Deploy to GitHub Pages
id: deploy
uses: actions/deploy-pages@v4