Fix typo in self_consistent_field documentation (#1015) #4117
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: Documentation | |
on: | |
push: | |
branches: | |
- master | |
tags: | |
- 'v*' | |
pull_request: | |
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: | |
name: Documentation | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: julia-actions/setup-julia@v1 | |
with: | |
version: '1' | |
- uses: julia-actions/julia-buildpkg@v1 | |
- uses: julia-actions/julia-docdeploy@v1 | |
timeout-minutes: 60 | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} | |
- name: Setup PyCall to use python executable from PythonCall | |
# Note: This is needed to ensure PyCall and PythonCall are using | |
# exactly the same python version. | |
run: | | |
julia --project -e ' | |
import Pkg | |
Pkg.add(["PyCall", "PythonCall"]) | |
import PythonCall | |
ENV["PYTHON"] = PythonCall.C.CTX.exe_path | |
Pkg.build("PyCall")' | |
- name: Run doctests | |
run: | | |
julia --project=docs -e ' | |
using Documenter: DocMeta, doctest | |
using DFTK | |
DocMeta.setdocmeta!(DFTK, :DocTestSetup, :(using DFTK); recursive=true) | |
doctest(DFTK)' | |
- name: Upload Docs | |
uses: actions/upload-artifact@v4 | |
with: | |
name: documentation | |
path: docs/build | |
retention-days: 1 |