diff --git a/README.md b/README.md index 80fd4c398..94b7bd6b1 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@
-[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliahub.com/docs/General/Sunny/stable) + [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://sunnysuite.github.io/Sunny.jl/dev) [![Build Status](https://github.com/SunnySuite/Sunny.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/SunnySuite/Sunny.jl/actions/workflows/CI.yml?query=branch%3Amain) diff --git a/docs/make.jl b/docs/make.jl index fc37c456b..c96b998a8 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,12 +1,14 @@ -# julia --project=@. make.jl - -import Literate, Documenter, Git -using Sunny, GLMakie, WriteVTK # Load packages to enable Documenter references +# To build docs, execute `julia --project=@. make.jl`. The JuliaHub build +# environment additionally uses `--compiled-modules=no`. isdraft = false # set `true` to disable cell evaluation -# Generate high resolution GLMakie images (two pixels per size "unit") -Makie.set_theme!(; GLMakie=(; px_per_unit=2)) +import Literate, Documenter, Git +using Sunny # Load `export`s into namespace to define API +import GLMakie, WriteVTK # Enable package extensions + +# Generate high resolution GLMakie images (two pixels per "size unit") +GLMakie.set_theme!(; GLMakie=(px_per_unit=2,)) # Remove existing Documenter `build` directory build_path = joinpath(@__DIR__, "build")