Skip to content

Merge pull request #129 from NCAR/fix-userguide-examples #101

Merge pull request #129 from NCAR/fix-userguide-examples

Merge pull request #129 from NCAR/fix-userguide-examples #101

Workflow file for this run

name: Build and Deploy Documentation
on:
push:
branches:
- main
workflow_dispatch:
jobs:
build:
name: Build and Deploy Documentation
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Cache pip dependencies
uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-pip-${{ hashFiles('docs/requirements.txt') }}
restore-keys: |
${{ runner.os }}-pip-
- name: Install dependencies
run: |
pip install -r docs/requirements.txt
- name: Build documentation
run: |
sphinx-build -b html docs/ docs/build/html
- name: Deploy to GitHub Pages
if: github.ref == 'refs/heads/main'
uses: peaceiris/actions-gh-pages@4f9cc6602d3f66b9c108549d475ec49e8ef4d45e #v4.0.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: docs/build/html