Skip to content

Commit

Permalink
switch docs to vitepress
Browse files Browse the repository at this point in the history
  • Loading branch information
gottacatchenall committed Jan 7, 2025
1 parent ee688a8 commit 67a133b
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 26 deletions.
5 changes: 4 additions & 1 deletion docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365"
NeutralLandscapes = "71847384-8354-4223-ac08-659a5128069f"
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
35 changes: 10 additions & 25 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,37 +1,22 @@
using Documenter, NeutralLandscapes
import Literate
push!(LOAD_PATH, "../src/")

# For GR docs bug
ENV["GKSwstype"] = "100"

vignettes = filter(
endswith(".jl"),
readdir(joinpath(@__DIR__, "src", "vignettes"); join = true, sort = true),
)
for vignette in vignettes
Literate.markdown(
vignette,
joinpath(@__DIR__, "src", "vignettes");
config = Dict("credit" => false, "execute" => true),
)
end
using Documenter
using DocumenterCitations
using DocumenterVitepress
using NeutralLandscapes

makedocs(;
sitename = "NeutralLandscapes",
authors = "M.D. Catchen",
modules = [NeutralLandscapes],
pages = [
sitename="NeutralLandscapes",
authors="M.D. Catchen",
modules=[NeutralLandscapes],
pages=[
"Index" => "index.md",
"Gallery" => "gallery.md",
"Vignettes" => [
"Overview" => "vignettes/overview.md",
],
],
checkdocs = :all,
warnonly=true
)

deploydocs(
repo="github.com/EcoJulia/NeutralLandscapes.jl.git",
devbranch="main",
push_preview=true
)

0 comments on commit 67a133b

Please sign in to comment.