Skip to content

Add basic documentation site #2

Add basic documentation site

Add basic documentation site #2

Workflow file for this run

name: Build Docs
on:
push:
branches:
- main
pull_request:
branches:
- main
workflow_dispatch: # Make sure this job can be triggered manually
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: read
pages: write
id-token: write
steps:
- uses: actions/checkout@v5
- uses: actions/configure-pages@v3
- uses: actions/setup-python@v5
with:
python-version: '3.13'
- name: Install dependencies
run: |
cd quaddtype/
python -m pip install --upgrade pip
python -m pip install "numpy @ git+https://github.com/numpy/numpy.git" pytest meson meson-python
- name: Build quaddtype package
run: |
cd quaddtype/
python -m pip install . -v --no-build-isolation
- name: Build Sphinx documentation
run: |
cd quaddtype/
python -m pip install ."[docs]"
make -C docs html
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './quaddtype/docs/_build/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4