Skip to content

Commit

Permalink
Change documentation build workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
ohno committed Nov 13, 2023
1 parent 212fe34 commit daea54c
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 23 deletions.
39 changes: 20 additions & 19 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -1,29 +1,30 @@
# https://documenter.juliadocs.org/stable/man/hosting/#GitHub-Actions

name: Documentation

on:
push:
branches:
- master # update to match your development branch (master, main, dev, trunk, ...)
tags: '*'
pull_request:

jobs:
build:
docs:
name: Documentation
runs-on: ubuntu-latest
permissions:
contents: write
statuses: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v3
- uses: julia-actions/setup-julia@v1
with:
version: '1.9'
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
version: '1'
- name: Configure doc environment
run: |
julia --project=docs/ -e '
using Pkg
Pkg.develop(PackageSpec(path=pwd()))
Pkg.instantiate()'
- uses: julia-actions/julia-buildpkg@v1
- uses: julia-actions/julia-docdeploy@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
run: julia --project=docs/ docs/make.jl
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- run: |
julia --project=docs -e '
using Documenter: DocMeta, doctest
using Antiq
DocMeta.setdocmeta!(Antiq, :DocTestSetup, :(using Antiq); recursive=true)
doctest(Antiq)'
4 changes: 2 additions & 2 deletions docs/src/InfinitePotentialWell.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ The infinite potential well (particle in a box) is the simplest model for quantu

#### Schrödinger Equation
```math
\psi(x) = E \psi(x)
\hat{H} \psi(x) = E \psi(x)
```

#### Hamiltonian
```math
\frac{\hbar^2}{2m} \frac{\mathrm{d}^2}{\mathrm{d}x ^2} + V(x)
\hat{H} = \frac{\hbar^2}{2m} \frac{\mathrm{d}^2}{\mathrm{d}x ^2} + V(x)
```

#### Potential
Expand Down
4 changes: 2 additions & 2 deletions docs/src/jmd/InfinitePotentialWell.jmd
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ The infinite potential well (particle in a box) is the simplest model for quantu

#### Schrödinger Equation
```math
\psi(x) = E \psi(x)
\hat{H} \psi(x) = E \psi(x)
```

#### Hamiltonian
```math
\frac{\hbar^2}{2m} \frac{\mathrm{d}^2}{\mathrm{d}x ^2} + V(x)
\hat{H} = \frac{\hbar^2}{2m} \frac{\mathrm{d}^2}{\mathrm{d}x ^2} + V(x)
```

#### Potential
Expand Down

0 comments on commit daea54c

Please sign in to comment.