Skip to content

Merge pull request #112 from shreyas-a-s/make-fields-optional #7

Merge pull request #112 from shreyas-a-s/make-fields-optional

Merge pull request #112 from shreyas-a-s/make-fields-optional #7

Workflow file for this run

name: Deploy Documentation using MkDocs
on:
push:
branches: ["2.x"]
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: 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:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- uses: actions/setup-python@v5
with:
python-version: '3.10'
- name: Install Depenendancies
run: pip install mkdocs mkdocs-material
- name: Build Documentation
run: |
cd mkdocs
mkdocs build
- name: Upload Documentation
uses: actions/upload-pages-artifact@v3
with:
path: mkdocs/site
# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4