Skip to content

#9 add release v0.2.1 #16

#9 add release v0.2.1

#9 add release v0.2.1 #16

Workflow file for this run

name: Deploy documentation
on:
push:
branches:
- main
# Allows you to run this workflow manually from the Actions tab
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:
name: Build documentation website with MkDocs
runs-on: ubuntu-latest
steps:
- name: Configure Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install mkdocs
run: |
pip install mkdocs mkdocs-material
pip install markdown-callouts
pip install mkdocs-literate-nav
pip install mkdocs-git-revision-date-localized-plugin
pip install mkdocs-git-committers-plugin-2
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive
fetch-depth: 0
- name: Setup Pages
id: pages
uses: actions/configure-pages@v4
- name: Build with mkdocs
run: mkdocs build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./site
deploy:
name: Deploy to GitHub Pages
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