Small updates to README and paper. #24
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: Documentation | |
| on: | |
| push: | |
| branches: | |
| - main # update to match your development branch (master, main, dev, trunk, ...) | |
| paths: | |
| - docs/** | |
| tags: '*' | |
| pull_request: | |
| workflow_dispatch: | |
| inputs: | |
| branch: | |
| description: 'Branch to run on' | |
| required: true | |
| default: 'main' | |
| type: string | |
| jobs: | |
| build: | |
| # These permissions are needed to: | |
| # - Deploy the documentation: https://documenter.juliadocs.org/stable/man/hosting/#Permissions | |
| # - Delete old caches: https://github.com/julia-actions/cache#usage | |
| permissions: | |
| actions: write | |
| contents: write | |
| pull-requests: read | |
| statuses: write | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: julia-actions/setup-julia@v2 | |
| with: | |
| version: '1' | |
| - uses: julia-actions/cache@v2 | |
| - name: Install dependencies | |
| shell: julia --color=yes --project=docs {0} | |
| run: | | |
| using Pkg | |
| Pkg.develop(PackageSpec(path=pwd())) | |
| Pkg.instantiate() | |
| - name: Build and deploy | |
| run: julia --color=yes --project=docs docs/make.jl | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token | |
| DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key |