Skip to content

Merge pull request #71 from nismod/tutorials #35

Merge pull request #71 from nismod/tutorials

Merge pull request #71 from nismod/tutorials #35

Workflow file for this run

name: docs
on:
push:
branches: ["main"]
# 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 job
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Pages
id: pages
uses: actions/configure-pages@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.11"
- name: Install dependencies and build python module
run: |
sudo apt-get install pandoc
python -m pip install --upgrade pip wheel setuptools
pip install --verbose .[docs]
- name: Build docs
run: |
pushd docs
sphinx-apidoc -M -o source/api ../src/snail/ --force
make html
popd
- name: Upload artifact
uses: actions/upload-pages-artifact@v2
with:
path: docs/build/html
# Deployment job
deploy:
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@v2