Merge pull request #90 from simbilod/docs #176
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: Sphinx docs to gh-pages | |
on: | |
push: | |
branches: | |
- main | |
workflow_dispatch: | |
jobs: | |
build-docs: | |
runs-on: ubuntu-latest | |
name: Build docs | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Install uv | |
uses: astral-sh/setup-uv@v4 | |
- name: Set up Python 3.12 | |
run: uv python install 3.12 | |
- name: Install venv | |
run: uv venv | |
- name: Install dependencies | |
run: | | |
sudo apt-get install libglu1-mesa | |
uv pip install -e ".[dev]" | |
- name: make docs | |
run: | | |
jupyter-book build docs/ --all | |
- name: Upload artifact | |
uses: actions/upload-pages-artifact@v3 | |
with: | |
path: "./docs/_build/html/" | |
deploy-docs: | |
needs: build-docs | |
permissions: | |
pages: write | |
id-token: write | |
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@v4 |