diff --git a/docs/Project.toml b/docs/Project.toml index b7023255..3fd53d7a 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -3,9 +3,11 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed" Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80" SummationByPartsOperators = "9f78cca6-572e-554e-b819-917d2f1cf240" +TrixiBase = "9a0f1c46-06d5-4909-a5a3-ce25d3fa3284" [compat] Documenter = "1" OrdinaryDiffEq = "6.49.1" Plots = "1.9" SummationByPartsOperators = "0.5.41" +TrixiBase = "0.1" diff --git a/docs/make.jl b/docs/make.jl index fa2b03c9..b2c3a7f6 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,12 +1,14 @@ -using DispersiveShallowWater using Documenter +using DispersiveShallowWater +using TrixiBase # Define module-wide setups such that the respective modules are available in doctests DocMeta.setdocmeta!(DispersiveShallowWater, :DocTestSetup, :(using DispersiveShallowWater); recursive = true) +DocMeta.setdocmeta!(TrixiBase, :DocTestSetup, :(using TrixiBase); recursive=true) makedocs(; - modules = [DispersiveShallowWater], + modules = [DispersiveShallowWater, TrixiBase], authors = "Joshua Lampert ", repo = Remotes.GitHub("JoshuaLampert", "DispersiveShallowWater.jl"), sitename = "DispersiveShallowWater.jl", @@ -18,7 +20,10 @@ makedocs(; pages = [ "Home" => "index.md", "Overview" => "overview.md", - "Reference" => "ref.md", + "Reference" => [ + "TrixiBase" => "ref-trixibase.md", + "DispersiveShallowWater" => "ref.md" + ], "License" => "license.md", ]) diff --git a/docs/src/ref-trixibase.md b/docs/src/ref-trixibase.md new file mode 100644 index 00000000..c7a970f8 --- /dev/null +++ b/docs/src/ref-trixibase.md @@ -0,0 +1,9 @@ +# TrixiBase.jl API + +```@meta +CurrentModule = TrixiBase +``` + +```@autodocs +Modules = [TrixiBase] +```