Skip to content

zarr-particle-tools support & small fixes and improvements #2

zarr-particle-tools support & small fixes and improvements

zarr-particle-tools support & small fixes and improvements #2

Workflow file for this run

name: Deploy Documentation
on:
push:
branches:
- main
- docs
paths:
- 'docs/**'
- 'mkdocs.yml'
- '.github/workflows/make-docs.yml'
pull_request:
branches:
- main
- docs
paths:
- 'docs/**'
- 'mkdocs.yml'
- '.github/workflows/make-docs.yml'
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.8'
cache: 'pip'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs-material
pip install mkdocs-git-revision-date-localized-plugin
pip install mkdocs-git-committers-plugin-2
pip install mkdocs-git-authors-plugin
pip install mkdocs-awesome-pages-plugin
pip install mkdocs-minify-plugin
pip install mkdocs-redirects
- name: Build documentation
run: mkdocs build
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./site
name: github-pages # Required for deploy-pages to find the artifact
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4