[docs]: Fixes and deployment to gh-pages #7
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: ICON4Py Quality Assurance and Docs | |
on: | |
workflow_dispatch: | |
push: | |
branches: | |
- main | |
pull_request: | |
branches: | |
- main | |
types: [opened, reopened, synchronize] | |
jobs: | |
pre-commit-icon4py-model: | |
runs-on: ubuntu-latest | |
steps: | |
# Step 1: Checkout the repository | |
- uses: actions/checkout@v3 | |
# Step 2: Install system dependencies | |
- name: Install system dependencies | |
run: | | |
sudo apt-get update | |
sudo apt-get install -y libboost-all-dev | |
# Step 3: Set up Python | |
- name: Set up Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: "3.10" | |
# Step 4: Install Python dependencies | |
- name: Install all icon4py namespace packages | |
run: | | |
python -m pip install --upgrade pip setuptools wheel | |
python -m pip install -r ./requirements-dev.txt | |
python -m pip list | |
# Step 5: Run pre-commit checks | |
- name: Run checks | |
run: | | |
pre-commit run | |
# Step 6: Build Sphinx documentation | |
- name: Build documentation | |
run: | | |
cd model/atmosphere/dycore/docs | |
make html | |
# Step 7: Deploy to GitHub Pages | |
- name: Deploy to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v4 | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: model/atmosphere/dycore/docs/_build/html |