Website #7
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: m2g Build | |
on: | |
push: | |
branches: | |
- "deploy" | |
- "main" | |
pull_request: | |
workflow_call: | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python 3.8 | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.8 | |
- name: "Run Reference Documentation Generation" | |
run: | | |
sudo apt install pandoc | |
pip install -U pip setuptools wheel | |
pip install -r docs/requirements.txt | |
sphinx-build -a docs/ docs/_build/html | |
- name: Archive documentation artifacts | |
uses: actions/upload-artifact@v4 | |
with: | |
name: documentation-site | |
path: docs/_build/html | |
# Deployment job | |
deploy: | |
runs-on: ubuntu-latest | |
needs: build | |
steps: | |
- name: "GitHub Pages action" | |
uses: peaceiris/actions-gh-pages@v3 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/_build/html | |
code-format-check: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Set up Python 3.8 | |
uses: actions/setup-python@v5 | |
with: | |
python-version: 3.8 | |
- name: Run Format Check | |
run: | | |
pip install -U pip setuptools wheel black isort | |
black --check --diff ./m2g | |
isort --check-only --profile black ./m2g |