Vectorize differenced process (#446) #1310
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: website | |
| on: | |
| push: | |
| branches: [main] | |
| pull_request: | |
| release: | |
| types: [published] | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| pages: write | |
| id-token: write | |
| jobs: | |
| render-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: quarto-dev/quarto-actions/setup@v2 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| - name: install poetry | |
| run: pip install poetry | |
| - name: install package | |
| run: poetry install --with docs | |
| # This section renders the quarto documents (and the README file) | |
| # and moves them to the docs/source/_compiled_qmd directory | |
| # which is then uploaded as an artifact. | |
| - name: Render documents | |
| run: | | |
| cd docs/source/tutorials | |
| poetry run make tutorials_clean | |
| poetry run make tutorials_rst | |
| # Upload | |
| - name: Upload artifacts | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: tutorials | |
| path: docs/source/tutorials | |
| build: | |
| needs: render-docs | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: quarto-dev/quarto-actions/setup@v2 | |
| # Setting up the environment | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.12' | |
| - name: Install Poetry | |
| run: pip install poetry | |
| - name: Install dependencies with Poetry | |
| run: poetry install --with docs | |
| - name: Render documentation index from README | |
| run: | | |
| poetry run quarto render README.md --to rst -o index.rst | |
| mv index.rst docs/source | |
| poetry run python docs/post_process_rst.py docs/source/index.rst | |
| # Download the rendered tutorials | |
| - name: Download artifacts | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: tutorials | |
| path: docs/source/tutorials/ | |
| # Building | |
| - name: Build HTML using Poetry | |
| run: poetry run sphinx-build -M html docs/source/ docs/build/ | |
| # Upload | |
| - name: Upload artifacts | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| name: github-pages | |
| path: docs/build/html/ | |
| deploy: | |
| # Deploy to the github-pages environment | |
| # but not on PRs | |
| if: ${{ github.event_name != 'pull_request' }} | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| needs: build | |
| # Specify runner + deployment step | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@v4 | |
| with: | |
| artifact_name: github-pages | |
| preview: true |