diff --git a/.gitignore b/.gitignore index 0bd0f101..5a56876b 100644 --- a/.gitignore +++ b/.gitignore @@ -5,4 +5,15 @@ .DS_Store docs/Manifest.toml test/Manifest.toml -docs/build/ \ No newline at end of file +docs/build/ + +# DocumenterVitepress: +docs/src/.vitepress/cache +docs/src/.vitepress/dist +docs/Manifest.toml +docs/.vscode +docs/node_modules +docs/.vitepress/cache +docs/.vitepress/dist +docs/.DS_Store +docs/package-lock.json \ No newline at end of file diff --git a/docs/Project.toml b/docs/Project.toml index 41aedce0..8296c3c6 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -3,6 +3,7 @@ CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b" CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0" DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" +DocumenterVitepress = "4710194d-e776-4893-9690-8d956a29c365" MultiScaleTreeGraph = "dd4a991b-8a45-4075-bede-262ee62d5583" PlantMeteo = "4630fe09-e0fb-4da5-a846-781cb73437b6" PlantSimEngine = "9a576370-710b-4269-adf9-4f603a9c6423" diff --git a/docs/make.jl b/docs/make.jl index feed87aa..ea445644 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,7 +1,7 @@ using PlantSimEngine using PlantMeteo using DataFrames, CSV -using Documenter +using Documenter, DocumenterVitepress using CairoMakie DocMeta.setdocmeta!(PlantSimEngine, :DocTestSetup, :(using PlantSimEngine, PlantMeteo, DataFrames, CSV, CairoMakie); recursive=true) @@ -11,12 +11,9 @@ makedocs(; authors="Rémi Vezy and contributors", repo=Documenter.Remotes.GitHub("VirtualPlantLab", "PlantSimEngine.jl"), sitename="PlantSimEngine.jl", - format=Documenter.HTML(; - prettyurls=get(ENV, "CI", "false") == "true", - canonical="https://VirtualPlantLab.github.io/PlantSimEngine.jl", - edit_link="main", - assets=String[], - size_threshold=300000 + format=DocumenterVitepress.MarkdownVitepress(; + repo="https://github.com/VirtualPlantLab/PlantSimEngine.jl", + # build_vitepress=false ), pages=[ "Home" => "index.md", @@ -37,12 +34,13 @@ makedocs(; ], "Modelers" => "./model_coupling/model_coupling_modeler.md", ], - "FAQ" => ["./FAQ/translate_a_model.md"], + "FAQ" => ["Translate a model" => "./FAQ/translate_a_model.md"], "API" => "API.md", ] ) deploydocs(; repo="github.com/VirtualPlantLab/PlantSimEngine.jl.git", - devbranch="main" + devbranch="main", + push_preview=true, # Visit https://VirtualPlantLab.github.io/PlantSimEngine.jl/previews/PR## to visualize the preview ) diff --git a/docs/src/index.md b/docs/src/index.md index 855b8903..82b6349a 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -38,11 +38,6 @@ run!(model2, meteo_day) [![DOI](https://zenodo.org/badge/571659510.svg)](https://zenodo.org/badge/latestdoi/571659510) [![JOSS](https://joss.theoj.org/papers/137e3e6c2ddc349bec39e06bb04e4e09/status.svg)](https://joss.theoj.org/papers/137e3e6c2ddc349bec39e06bb04e4e09) -```@contents -Pages = ["index.md"] -Depth = 5 -``` - ## Overview `PlantSimEngine` is a comprehensive package for simulating and modelling plants, soil and atmosphere. It provides tools to **prototype, evaluate, test, and deploy** plant/crop models at any scale. At its core, PlantSimEngine is designed with a strong emphasis on performance and efficiency.