diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 4c6d9e1..e12b39d 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -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 \ No newline at end of file + 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)' \ No newline at end of file diff --git a/docs/src/InfinitePotentialWell.md b/docs/src/InfinitePotentialWell.md index 5956b35..0d3191c 100644 --- a/docs/src/InfinitePotentialWell.md +++ b/docs/src/InfinitePotentialWell.md @@ -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 diff --git a/docs/src/jmd/InfinitePotentialWell.jmd b/docs/src/jmd/InfinitePotentialWell.jmd index 0fd7067..263f1f6 100644 --- a/docs/src/jmd/InfinitePotentialWell.jmd +++ b/docs/src/jmd/InfinitePotentialWell.jmd @@ -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