Add count_unique_box_instructions
#765
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: Build Docs | |
| # This workflow builds the docs on all branches and releases, | |
| # but it only deploys for the main branch and releases. Specifically | |
| # - Deploy to gh-pages:dev/ for builds of main | |
| # - Deploy to gh-pages:/ for builds of release | |
| # - Also deploy to gh-pages:/stable/<version> for builds of release | |
| # This third step is done to make the version drop-down menu work | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| pull_request: | |
| branches: [ "main" ] | |
| release: | |
| types: [published] | |
| jobs: | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python 3.11 | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.11" | |
| - name: Discover released versions | |
| run: echo "RELEASED_VERSIONS=$(curl -s https://raw.githubusercontent.com/${{ github.repository }}/gh-pages/versions.json | jq -r 'join(",")')" >> $GITHUB_ENV | |
| - name: Setup Graphviz | |
| uses: ts-graphviz/setup-graphviz@v2 | |
| - name: Install dependencies | |
| run: | | |
| python -m pip install --upgrade pip | |
| python -m pip install ".[dev,vis]" | |
| - name: Build documentation | |
| run: | | |
| echo "Using RELEASED_VERSIONS=$RELEASED_VERSIONS" | |
| # these commands should match what's in the README | |
| cd docs | |
| make html | |
| - name: Upload built docs | |
| uses: actions/upload-artifact@v4 | |
| if: always() # set always() so we can look at the artifact even if the build fails | |
| with: | |
| name: sphinx-docs | |
| path: docs/_build/html | |
| deploy-dev: | |
| if: github.ref == 'refs/heads/main' | |
| needs: build | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Download artifact | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: sphinx-docs | |
| path: site | |
| - name: Deploy to dev | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| folder: site | |
| target-folder: dev | |
| deploy-stable: | |
| if: startsWith(github.ref, 'refs/tags/') | |
| needs: build | |
| permissions: | |
| contents: write | |
| pages: write | |
| id-token: write | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Download artifact | |
| uses: actions/download-artifact@v4 | |
| with: | |
| name: sphinx-docs | |
| path: site | |
| - name: Bypass Jekyll Processing # Necessary for setting the correct css path | |
| run: touch site/.nojekyll | |
| - name: Deploy | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| folder: site | |
| clean-exclude: | | |
| stable/* | |
| dev/* | |
| benchmarks/* | |
| - name: Deploy to stable | |
| uses: JamesIves/github-pages-deploy-action@v4 | |
| with: | |
| folder: site | |
| target-folder: stable/${{ github.ref_name }} |