docs: build docs on CI deploy to github-pages on push to main #9
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: Deploy Docs to GitHub Pages | |
on: | |
push: | |
branches: [main] | |
workflow_dispatch: | |
pull_request: | |
# you can trigger the docs build on a PR by adding the label 'documentation' | |
# it will still only deploy on the main branch | |
types: [labeled] | |
# Allow this job to clone the repo and create a page deployment | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
jobs: | |
build: | |
if: contains(github.event.pull_request.labels.*.name, 'documentation') || github.event_name != 'pull_request' | |
runs-on: macos-latest | |
defaults: | |
run: | |
shell: bash -l {0} | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v3 | |
- uses: conda-incubator/setup-miniconda@v2 | |
with: | |
python-version: "3.11" | |
mamba-version: "*" | |
channels: conda-forge | |
channel-priority: true | |
- name: Install package and dependencies | |
run: | | |
mamba install -c gurobi -c funkelab ilpy | |
python -m pip install -e .[docs] | |
- name: Build documentation | |
run: sphinx-build docs/source docs/build/html -W -b html | |
- name: Upload Pages Artifact | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
path: docs/build/html | |
retention-days: 90 | |
deploy: | |
if: github.ref == 'refs/heads/main' | |
needs: build | |
# Deploy to the github-pages environment | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v1 |