Skip to content

Commit

Permalink
generate API for TrixiBase.jl in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JoshuaLampert committed Feb 8, 2024
1 parent bdc9108 commit f44dc95
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 3 deletions.
2 changes: 2 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
11 changes: 8 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -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 <[email protected]>",
repo = Remotes.GitHub("JoshuaLampert", "DispersiveShallowWater.jl"),
sitename = "DispersiveShallowWater.jl",
Expand All @@ -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",
])

Expand Down
9 changes: 9 additions & 0 deletions docs/src/ref-trixibase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# TrixiBase.jl API

```@meta
CurrentModule = TrixiBase
```

```@autodocs
Modules = [TrixiBase]
```

0 comments on commit f44dc95

Please sign in to comment.