[docs] Update wording and references. #174
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: | |
| - master | |
| tags: '*' | |
| pull_request: | |
| types: [opened, synchronize, reopened] | |
| 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: | |
| 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' | |
| show-versioninfo: true # versioninfo will be printed to the action log | |
| - uses: julia-actions/cache@v2 | |
| # - uses: julia-actions/julia-buildpkg@v1 # if package requires Pkg.build() | |
| - 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 |