This repository was archived by the owner on Dec 2, 2025. It is now read-only.
fmt #718
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: 📖 | |
| on: | |
| push: | |
| pull_request: | |
| branches: [main] | |
| merge_group: | |
| jobs: | |
| build-docs: | |
| name: Build docs | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Set up Rust | |
| uses: actions-rust-lang/setup-rust-toolchain@v1 | |
| with: | |
| toolchain: "nightly" | |
| - name: Install LAPACK, OpenBLAS, SCOTCH | |
| run: | |
| sudo apt-get install -y libopenblas-dev liblapack-dev libscotch-dev | |
| - name: Set up MPI | |
| uses: mpi4py/setup-mpi@v1 | |
| with: | |
| mpi: "mpich" | |
| - uses: actions/checkout@v4 | |
| - name: Set up Python | |
| uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.14 | |
| - name: Insert doc links | |
| run: python .github/scripts/insert_doc_links.py | |
| - name: Build docs | |
| run: RUSTDOCFLAGS="--html-in-header katex-header.html" cargo +nightly doc --no-deps -Zunstable-options -Zrustdoc-scrape-examples --all-features | |
| - name: Make index page | |
| run: echo "<html><head><meta http-equiv='refresh' content='0; URL=ndgrid'></head></html>" > target/doc/index.html | |
| - name: Set file permissions | |
| run: | | |
| rm target/doc/.lock | |
| chmod -c -R +rX target/doc | |
| - name: Setup Pages | |
| uses: actions/configure-pages@v3 | |
| if: github.ref == 'refs/heads/main' | |
| - name: Upload artifact for docs | |
| uses: actions/upload-pages-artifact@v3 | |
| with: | |
| path: 'target/doc' | |
| if: github.ref == 'refs/heads/main' | |
| deploy-docs: | |
| name: Deploy docs to GitHub pages | |
| runs-on: ubuntu-latest | |
| needs: | |
| - build-docs | |
| if: github.ref == 'refs/heads/main' | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| permissions: | |
| pages: write | |
| id-token: write | |
| steps: | |
| - name: Deploy docs to GitHub Pages | |
| uses: actions/deploy-pages@v4 |