docs: updated the contributing guide for uv #196
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: documentation | |
| on: [push, pull_request, workflow_dispatch] | |
| # needed to allow julia-actions/cache to delete old caches that it has created | |
| permissions: | |
| actions: write | |
| contents: write | |
| jobs: | |
| docs: | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: ./.github/actions/set-versions | |
| - uses: julia-actions/setup-julia@v2 | |
| with: | |
| version: ${{env.VERSION_JULIA}} | |
| - uses: julia-actions/cache@v2 | |
| - uses: astral-sh/setup-uv@v5 | |
| with: | |
| version: ${{env.VERSION_UV}} | |
| - name: Sphinx build | |
| run: | | |
| uv run sphinx-build docs docs/_build | |
| - name: Deploy to GitHub Pages | |
| uses: peaceiris/actions-gh-pages@v3 | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| with: | |
| publish_branch: gh-pages | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_dir: docs/_build/ | |
| force_orphan: true |