diff --git a/docs/make.jl b/docs/make.jl index 7fce3b31e24..fb43b712bb2 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -122,6 +122,7 @@ makedocs( "Troubleshooting and FAQ" => "troubleshooting.md", "Reference" => [ "Trixi.jl" => "reference-trixi.md", + "TrixiBase.jl" => "reference-trixibase.md", "Trixi2Vtk.jl" => "reference-trixi2vtk.md" ], "Authors" => "authors.md", diff --git a/docs/src/callbacks.md b/docs/src/callbacks.md index 21e934b6278..f018bcf7c39 100644 --- a/docs/src/callbacks.md +++ b/docs/src/callbacks.md @@ -112,7 +112,7 @@ will yield the following plot: * The [`VisualizationCallback`](@ref) can be used for in-situ visualization. See [Visualizing results during a simulation](@ref). * The [`TrivialCallback`](@ref) does nothing and can be used to easily disable some callbacks - via [`trixi_include`](https://trixi-framework.github.io/TrixiBase.jl/stable/reference/#TrixiBase.trixi_include-Tuple{Module,%20AbstractString}). + via [`trixi_include`](@ref). ### Equation-specific callbacks Some callbacks provided by Trixi.jl implement specific features for certain equations: diff --git a/docs/src/conventions.md b/docs/src/conventions.md index e1a41502a35..4f9e0ec4e67 100644 --- a/docs/src/conventions.md +++ b/docs/src/conventions.md @@ -48,10 +48,10 @@ Julia scripts containing everything to set up and run a simulation. Working interactively from the Julia REPL with these scripts can be quite convenient while for exploratory research and development of Trixi.jl. For example, you can use the convenience function -[`trixi_include`](https://trixi-framework.github.io/TrixiBase.jl/stable/reference/#TrixiBase.trixi_include-Tuple{Module,%20AbstractString}) +[`trixi_include`](@ref) to `include` an elixir with some modified arguments. To enable this, it is helpful to use a consistent naming scheme in elixirs, since -[`trixi_include`](https://trixi-framework.github.io/TrixiBase.jl/stable/reference/#TrixiBase.trixi_include-Tuple{Module,%20AbstractString}) +[`trixi_include`](@ref) can only perform simple replacements. Some standard variables names are - `polydeg` for the polynomial degree of a solver diff --git a/docs/src/reference-trixibase.md b/docs/src/reference-trixibase.md new file mode 100644 index 00000000000..c7a970f88ec --- /dev/null +++ b/docs/src/reference-trixibase.md @@ -0,0 +1,9 @@ +# TrixiBase.jl API + +```@meta +CurrentModule = TrixiBase +``` + +```@autodocs +Modules = [TrixiBase] +``` diff --git a/src/auxiliary/special_elixirs.jl b/src/auxiliary/special_elixirs.jl index 355f5dfce0a..d0bdb26899a 100644 --- a/src/auxiliary/special_elixirs.jl +++ b/src/auxiliary/special_elixirs.jl @@ -12,7 +12,7 @@ Run `iterations` Trixi.jl simulations using the setup given in `elixir` and comp the experimental order of convergence (EOC) in the ``L^2`` and ``L^\\infty`` norm. In each iteration, the resolution of the respective mesh will be doubled. Additional keyword arguments `kwargs...` and the optional module `mod` are passed directly -to [`trixi_include`](https://trixi-framework.github.io/TrixiBase.jl/stable/reference/#TrixiBase.trixi_include-Tuple{Module,%20AbstractString}). +to [`trixi_include`](@ref). This function assumes that the spatial resolution is set via the keywords `initial_refinement_level` (an integer) or `cells_per_dimension` (a tuple of diff --git a/src/callbacks_step/trivial.jl b/src/callbacks_step/trivial.jl index ab1f2ee6481..fb93cf96c0c 100644 --- a/src/callbacks_step/trivial.jl +++ b/src/callbacks_step/trivial.jl @@ -9,7 +9,7 @@ TrivialCallback() A callback that does nothing. This can be useful to disable some callbacks easily via -[`trixi_include`](https://trixi-framework.github.io/TrixiBase.jl/stable/reference/#TrixiBase.trixi_include-Tuple{Module,%20AbstractString}). +[`trixi_include`](@ref). """ function TrivialCallback() DiscreteCallback(trivial_callback, trivial_callback,