Docs #415
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: Docs | |
| on: | |
| pull_request: | |
| push: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| schedule: | |
| - cron: '0 0 * * *' # Runs at 00:00 UTC every day | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| name: Sphinx docs to gh-pages | |
| steps: | |
| - name: Cancel Workflow Action | |
| uses: styfle/[email protected] | |
| - uses: actions/checkout@v4 | |
| - uses: actions/cache@v4 | |
| with: | |
| path: | | |
| ~/.gdsfactory/ | |
| key: 0.0.1 | |
| restore-keys: 0.0.1 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: '3.11' | |
| - name: Install uv | |
| uses: astral-sh/setup-uv@v5 | |
| - name: Installing the library | |
| run: | | |
| make dev | |
| - name: Build the docs | |
| env: | |
| GDSFACTORY_DISPLAY_TYPE: klayout | |
| KFACTORY_DISPLAY_TYPE: image | |
| run: | | |
| make docs | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: "./docs/_build/html/" | |
| deploy-docs: | |
| needs: build-docs | |
| if: ${{ github.ref == 'refs/heads/main' }} | |
| 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 |