Documentation #10
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
| # see https://juliadocs.github.io/Documenter.jl/dev/man/hosting/#GitHub-Actions | |
| # add this file to the repository once you set up authentication as described in the Documenter manual | |
| name: Documentation | |
| on: | |
| push: | |
| branches: | |
| - master | |
| tags: '*' | |
| pull_request: | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| permissions: | |
| actions: write | |
| contents: write | |
| pull-requests: read | |
| statuses: write | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: julia-actions/setup-julia@latest | |
| with: | |
| version: '1' | |
| - name: Install dependencies | |
| run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' | |
| - name: Build and deploy | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token | |
| # DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key | |
| run: julia --project=docs/ docs/make.jl | |
| - name: Upload Documentation as Artifact | |
| uses: actions/upload-artifact@v4 | |
| with: | |
| name: documentation-output | |
| path: docs |