Update documentation for changes in NQCBase#11 #988
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
| # This is a basic workflow to help you get started with Actions | |
| name: Documentation | |
| on: | |
| push: | |
| branches: [main] | |
| tags: '*' | |
| pull_request: | |
| jobs: | |
| Documenter: | |
| name: Documentation | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: julia-actions/setup-julia@latest | |
| - uses: actions/cache@v3 | |
| env: | |
| cache-name: cache-artifacts | |
| with: | |
| path: ~/.julia/artifacts | |
| key: ${{ runner.os }}-docs-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }} | |
| restore-keys: | | |
| ${{ runner.os }}-docs-${{ env.cache-name }}- | |
| ${{ runner.os }}-docs- | |
| - name: Add registries | |
| run: | | |
| using Pkg | |
| Pkg.Registry.add(RegistrySpec(url="https://github.com/NQCD/NQCRegistry")) | |
| Pkg.Registry.add(RegistrySpec(url="https://github.com/JuliaMolSim/MolSim")) | |
| Pkg.Registry.add(RegistrySpec(url="https://github.com/ACEsuit/ACEregistry")) | |
| Pkg.Registry.add(RegistrySpec(name="General")) | |
| shell: julia --color=yes {0} | |
| - name: Install ase | |
| run: python3 -m pip install ase | |
| - name: Dev dependencies | |
| run: | | |
| using Pkg | |
| Pkg.develop([(;path=pwd()), (;name="NQCModels")]) | |
| Pkg.instantiate() | |
| shell: julia --color=yes --project=docs/ {0} | |
| - name: Build and deploy | |
| run: julia --color=yes --project=docs/ docs/make.jl | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} | |
| GKSwstype: "100" # https://discourse.julialang.org/t/generation-of-documentation-fails-qt-qpa-xcb-could-not-connect-to-display/60988 | |