Transformations module implementation #52
Workflow file for this run
This file contains hidden or 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: Docs Preview | |
| on: | |
| pull_request: | |
| branches: [ main ] | |
| permissions: | |
| contents: read | |
| jobs: | |
| build-preview: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Sync submodules to tracked branches | |
| run: | | |
| git submodule sync --recursive | |
| git submodule update --init --remote --recursive | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.12" | |
| cache: "pip" | |
| - name: Install Poetry | |
| run: pip install poetry | |
| - name: Install dependencies (with docs) | |
| run: poetry install --with docs | |
| - name: Generate API + copy notebooks | |
| run: poetry run python docs/source/generate_api.py | |
| - name: Build docs (Sphinx) | |
| run: | | |
| poetry run sphinx-build -E -a -b html docs/source docs/build/html | |
| touch docs/build/html/.nojekyll | |
| - name: Upload docs preview artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: docs-html-preview | |
| path: docs/build/html | |
| retention-days: 7 |