docs: add docstrings to all julia models #142
This file contains 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: docs | |
| on: | |
| push: | |
| branches: | |
| - main | |
| - fergus/docs | |
| concurrency: | |
| # cancels when a PR gets updated | |
| group: ${{ github.head_ref || github.run_id }}-${{ github.actor }} | |
| cancel-in-progress: true | |
| jobs: | |
| docs: | |
| name: Build and publish | |
| timeout-minutes: 30 | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: julia-actions/setup-julia@v1 | |
| with: | |
| version: '1.11' | |
| - uses: actions/cache@v1 | |
| env: | |
| cache-name: cache-artifacts | |
| with: | |
| path: ~/.julia/artifacts | |
| key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }} | |
| restore-keys: | | |
| ${{ runner.os }}-test-${{ env.cache-name }}- | |
| ${{ runner.os }}-test- | |
| ${{ runner.os }}- | |
| - name: Setup data directories | |
| run: | | |
| wget "https://www.star.bristol.ac.uk/fergus/spectral-fitting/ci-data/1E-1048-5937.tar" | |
| mkdir ex-datadir | |
| tar -xf 1E-1048-5937.tar -C ex-datadir/ | |
| - name: Build documentation | |
| run: | | |
| julia -e 'import Pkg; Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/astro-group-bristol/AstroRegistry/"))' | |
| julia -e 'import Pkg; Pkg.Registry.add(Pkg.RegistrySpec(url="https://github.com/JuliaRegistries/General"))' | |
| julia --project=docs -e ' | |
| using Pkg | |
| Pkg.instantiate() | |
| Pkg.develop(PackageSpec(path=pwd())) | |
| Pkg.develop(PackageSpec(path=joinpath(pwd(), "lib", "XSPECModels"))) | |
| Pkg.instantiate()' | |
| - run: julia --color=yes -tauto --project=docs docs/make.jl | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |