Skip to content

Commit

Permalink
fix for documenter 1.1 (JuliaMolSim#882)
Browse files Browse the repository at this point in the history
* fix for documenter 1.1

* disabling AtomsIO

* increasing timeout – more logical ordering of function definition

* no size threshold
  • Loading branch information
epolack authored Oct 3, 2023
1 parent 097a1ab commit e119077
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:
version: '1'
- uses: julia-actions/julia-buildpkg@v1
- uses: julia-actions/julia-docdeploy@v1
timeout-minutes: 40
timeout-minutes: 60
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
Expand Down
2 changes: 1 addition & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ WriteVTK = "64499a7a-5c06-52f2-abe2-ccb03c286192"
wannier90_jll = "c5400fa0-8d08-52c2-913f-1e3f656c1ce9"

[compat]
Documenter = "~0.27"
Documenter = "~1.1"
8 changes: 4 additions & 4 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -127,13 +127,13 @@ import Artifacts
#

# Get list of files from PAGES
extract_paths(pages::AbstractArray) = collect(Iterators.flatten(extract_paths.(pages)))
extract_paths(file::AbstractString) = [file]
extract_paths(pages::AbstractArray) = collect(Iterators.flatten(extract_paths.(pages)))
extract_paths(pair::Pair) = extract_paths(pair.second)

# Transform files to *.md
transform_to_md(pages::AbstractArray) = transform_to_md.(pages)
transform_to_md(file::AbstractString) = first(splitext(file)) * ".md"
transform_to_md(pages::AbstractArray) = transform_to_md.(pages)
transform_to_md(pair::Pair) = (pair.first => transform_to_md(pair.second))

# Setup Artifacts.toml system
Expand Down Expand Up @@ -188,7 +188,6 @@ end
# Generate the docs in BUILDPATH
makedocs(;
modules=[DFTK],
repo="https://" * DFTKGH * "/blob/{commit}{path}#{line}",
format=Documenter.HTML(
# Use clean URLs, unless built as a "local" build
prettyurls = CONTINUOUS_INTEGRATION,
Expand All @@ -202,12 +201,13 @@ makedocs(;
:braket => [raw"\left\langle#1\middle|#2\right\rangle", 2],
),
))),
size_threshold=nothing, # do not fail build if large HTML outputs
),
sitename = "DFTK.jl",
authors = "Michael F. Herbst, Antoine Levitt and contributors.",
pages=transform_to_md(PAGES),
checkdocs=:exports,
strict=!DEBUG,
warnonly=DEBUG,
)

# Dump files for managing dependencies in binder
Expand Down
3 changes: 2 additions & 1 deletion examples/atomsbase.jl
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ using AtomsIO

## Read a file using [AtomsIO](https://github.com/mfherbst/AtomsIO.jl),
## which directly yields an AbstractSystem.
system = load_system("Si.extxyz")
## Disabled for now, due to issue with AtomsIO.
## system = load_system("Si.extxyz")

## Now run the LDA calculation:
system = attach_psp(system; Si="hgh/lda/si-q4")
Expand Down

0 comments on commit e119077

Please sign in to comment.