-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
generate API for TrixiBase.jl in docs
- Loading branch information
1 parent
bdc9108
commit f44dc95
Showing
3 changed files
with
19 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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", | ||
|
@@ -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", | ||
]) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# TrixiBase.jl API | ||
|
||
```@meta | ||
CurrentModule = TrixiBase | ||
``` | ||
|
||
```@autodocs | ||
Modules = [TrixiBase] | ||
``` |