docs: add package overview, installation guide and usage examples to … #1
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 | |
| paths: | |
| - "src/**" | |
| - "docs/**" | |
| - "Project.toml" | |
| tags: ["*"] | |
| pull_request: | |
| paths: | |
| - "src/**" | |
| - "docs/**" | |
| - "Project.toml" | |
| workflow_dispatch: | |
| concurrency: | |
| # Skip intermediate builds: always. | |
| # Cancel intermediate builds: only if it is a pull request build. | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }} | |
| jobs: | |
| docs: | |
| permissions: | |
| actions: write # needed to allow julia-actions/cache to proactively delete old caches that it has created | |
| contents: write | |
| pull-requests: read | |
| statuses: write | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Build and deploy Documenter.jl docs | |
| uses: JuliaSpacePhysics/actions/DocsDocumenter@main |