From f3241671d7bd0a53a7d45ff661604f361c4abb7d Mon Sep 17 00:00:00 2001 From: Daniel Vedder <daniel.vedder@idiv.de> Date: Tue, 14 Jan 2025 16:43:19 +0100 Subject: [PATCH] Added PDF manual export (#91) Still needs prettifying --- docs/builddocs.jl | 36 ++++++++++++++++++++++++++++++++++++ docs/src/index.md | 2 +- 2 files changed, 37 insertions(+), 1 deletion(-) diff --git a/docs/builddocs.jl b/docs/builddocs.jl index 2f7268b..246b4fb 100644 --- a/docs/builddocs.jl +++ b/docs/builddocs.jl @@ -12,6 +12,7 @@ push!(LOAD_PATH, "../src/") using Documenter, Persefone +# build the online documentation makedocs(sitename="Persefone.jl", modules = [Persefone], repo = Remotes.GitLab("git.idiv.de", "persefone", "persefone-model"), @@ -44,3 +45,38 @@ makedocs(sitename="Persefone.jl", "crops.md", "farm.md"] ]) + +# compile the handbook +makedocs(format = Documenter.LaTeX(), + sitename="Persefone.jl manual", + authors="Vedder, Matthies, Pe'er", + modules = [Persefone], + repo = Remotes.GitLab("git.idiv.de", "persefone", "persefone-model"), + warnonly = true, #XXX not recommended + #warnonly = [:cross_references], + pages = ["index.md", + "User guide" => [ + "using.md", + "gui.md", + "config.md"], + #"odd.md", + "Scientific documentation" => [ + "management.md", + "crop-models.md", + "skylark.md"], + "Developer guide" => [ + "developing.md", + "adapting.md", + "architecture.md", + "gis.md", + "species-dsl.md", + "CHANGELOG.md"], + "Software API" => [ + "simulation.md", + "io.md", + "nature.md", + #"energy.md", + "species.md", + "crops.md", + "farm.md"] + ]) diff --git a/docs/src/index.md b/docs/src/index.md index befb750..3c51bd2 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -14,4 +14,4 @@ changes in farm operations (e.g. through policy changes in the CAP) influence bi The model is open-source software available on [Gitlab](https://git.idiv.de/persefone/persefone-model). -*This documentation was last updated on 2024-09-11 for **Persefone.jl v0.5.5** (commit [6b3aee6](https://git.idiv.de/persefone/persefone-model/-/commit/6b3aee6)).* +*This documentation was last updated on 2025-01-14 for **Persefone.jl v0.6.0** (commit [479afb4](https://git.idiv.de/persefone/persefone-model/-/commit/479afb4)).* -- GitLab