docs: Add compiler API docs #1
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: Build and publish docs | |
on: | |
workflow_dispatch: | |
push: | |
branches: | |
- main | |
# Temporary: Run on PR to test the CI | |
pull_request: | |
branches: | |
- main | |
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
permissions: | |
contents: read | |
pages: write | |
id-token: write | |
jobs: | |
build-publish: | |
name: Build and publish docs | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- name: Run sccache-cache | |
uses: mozilla-actions/[email protected] | |
- name: Install poetry | |
run: pipx install poetry | |
- name: Set up Python '3.10' | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.10' | |
cache: "poetry" | |
- name: Install Guppy | |
run: poetry install -- with docs | |
- name: Build docs | |
run: | | |
cd docs | |
./build.sh | |
cd .. | |
- name: Setup pages. | |
uses: actions/configure-pages@v2 | |
- name: Upload artifact. | |
uses: actions/upload-pages-artifact@v1 | |
with: | |
path: ./docs/build/ | |
- name: Deploy to GitHub Pages. | |
id: deployment | |
uses: actions/deploy-pages@v4 |